Bệnh nhân VN Core — VN Core Patient Profile - Bộ Hướng dẫn Triển khai Core FHIR cho Việt Nam v0.3.0

Is Modifier false

Summary true

4. Patient.meta

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Short Metadata about the resource

Control 0..1

Meta

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

6. Patient.implicitRules

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Short A set of rules under which this content was created

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control 0..1

Is Modifier true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation

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()))

8. Patient.language

Definition

The base language in which the resource is written.

Short Language of the resource content

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control 0..1

The codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

A human language.

Additional Bindings

Purpose

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

10. Patient.text

Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Short Text summary of the resource, for human interpretation

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control 0..1

Narrative

Is Modifier false

Summary false

Alternate Names narrative, html, xhtml, display

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

12. Patient.contained

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Short Contained, inline Resources

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Control 0..*

Resource

Is Modifier false

Summary false

Alternate Names inline resources, anonymous resources, contained resources

14. Patient.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

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())

This element introduces a set of slices on Patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

16. Patient.extension:ethnicity

Slice Name ethnicity

Definition

Dân tộc theo danh mục 54 dân tộc Việt Nam (TCTK)

Short Dân tộc

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(Dân tộc — Vietnam Ethnicity Extension) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

18. Patient.extension:religion

Slice Name religion

Definition

Tôn giáo theo extension chuẩn patient-religion, bind về danh mục tôn giáo Việt Nam khi triển khai trong nước

Short Tôn giáo

Control 0..1

Type Extension(Patient Religion) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

20. Patient.extension:religion.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
This element is affected by the following invariants: ele-1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

22. Patient.extension:religion.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

24. Patient.extension:religion.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

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.

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://hl7.org/fhir/StructureDefinition/patient-religion

26. Patient.extension:religion.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 1..1
This element is affected by the following invariants: ext-1

Binding The codes SHALL be taken from Danh mục Tôn giáo Việt Nam — Vietnam Religion ValueSet
(required to http://fhir.hl7.org.vn/core/ValueSet/vn-religion-vs)

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

28. Patient.extension:occupation

Slice Name occupation

Definition

Nghề nghiệp theo VSCO 2020 (QĐ 34/2020/QĐ-TTg) — 1.516 mã, tương thích ISCO-08

Short Nghề nghiệp

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(Nghề nghiệp — Vietnam Occupation Extension) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

30. Patient.extension:citizenship

Slice Name citizenship

Definition

Quốc tịch của người bệnh. Sử dụng extension chuẩn patient-citizenship để tương thích quốc tế; khuyến nghị mã hóa theo ISO 3166-1

Short Quốc tịch

Control 0..*

Type Extension(Patient Citizenship) (Complex Extension)

Is Modifier false

32. Patient.extension:citizenship.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
This element is affected by the following invariants: ele-1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

34. Patient.extension:citizenship.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 managable, 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..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

36. Patient.extension:citizenship.extension:code

Slice Name code

Definition

An Extension

Short Extension

Control 0..1

Is Modifier false

Summary false

38. Patient.extension:citizenship.extension:code.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
This element is affected by the following invariants: ele-1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

40. Patient.extension:citizenship.extension:code.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

42. Patient.extension:citizenship.extension:code.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value code

44. Patient.extension:citizenship.extension:code.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Mã quốc tịch

Control 1..1
This element is affected by the following invariants: ext-1

Binding The codes SHALL be taken from Quốc tịch theo ISO 3166-1 alpha-2 — Country ValueSet for Patient Citizenship
(required to http://fhir.hl7.org.vn/core/ValueSet/vn-country-vs)

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

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()))

46. Patient.extension:citizenship.extension:period

Slice Name period

Definition

An Extension

Short Extension

Control 0..1

Is Modifier false

Summary false

48. Patient.extension:citizenship.extension:period.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
This element is affected by the following invariants: ele-1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

50. Patient.extension:citizenship.extension:period.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

52. Patient.extension:citizenship.extension:period.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value period

54. Patient.extension:citizenship.extension:period.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Thời hạn quốc tịch (nếu có)

Control 1..1
This element is affected by the following invariants: ext-1

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

56. Patient.extension:citizenship.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://hl7.org/fhir/StructureDefinition/patient-citizenship

58. Patient.extension:citizenship.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 0..0
This element is affected by the following invariants: ext-1

Type Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

60. Patient.extension:birthPlace

Slice Name birthPlace

Definition

Nơi sinh của người bệnh theo extension chuẩn patient-birthPlace, dùng VNCoreAddress để bảo toàn tỉnh/xã phục vụ đối soát dân cư

Short Nơi sinh

Control 0..1

Type Extension(Patient Birth Place) (Extension Type: Address)

Is Modifier false

Summary false

62. Patient.extension:birthPlace.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
This element is affected by the following invariants: ele-1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

64. Patient.extension:birthPlace.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

66. Patient.extension:birthPlace.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://hl7.org/fhir/StructureDefinition/patient-birthPlace

68. Patient.extension:birthPlace.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 1..1
This element is affected by the following invariants: ext-1

Type Address(Địa chỉ VN Core — VN Core Address Profile)

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

70. Patient.extension:forceMajeureReason

Slice Name forceMajeureReason

Definition

Lý do nghiệp vụ cho phép để trống CCCD trong các ca bất khả kháng theo hướng dẫn dữ liệu KCB/BHYT hiện hành. Không dùng extension này cho người bệnh có định danh thay thế hợp lệ như hộ chiếu hoặc giấy khai sinh

Short Lý do bất khả kháng khi chưa có CCCD

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(Lý do bất khả kháng thiếu CCCD — Force Majeure Reason Extension) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

72. Patient.modifierExtension

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them

Summary false

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, user content

74. Patient.identifier

Definition

An identifier for this patient.

Short Định danh bệnh nhân (CCCD, BHYT, MRN...)

Note This is a business identifier, not a resource identifier (see discussion)

Control 1..*

Is Modifier false

Must Support true

Summary true

Requirements

Patients are almost always assigned specific numerical identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

This element introduces a set of slices on Patient.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ system

76. Patient.identifier:CCCD

Slice Name CCCD

Definition

Số căn cước công dân 12 chữ số — identifier chính theo TT 13/2025. Nếu người bệnh chưa có CCCD hoặc không thuộc hệ CCCD thì vẫn giữ slice này với data-absent-reason và khai báo định danh thay thế hợp lệ theo guidance

Short Số CCCD (Căn cước công dân)

Note This is a business identifier, not a resource identifier (see discussion)

Control 1..1

Is Modifier false

Must Support true

Summary true

Requirements

Patients are almost always assigned specific numerical identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
vn-cccd-format: Số CCCD phải đúng 12 chữ số (Luật Căn cước 2023, Điều 20) (value.empty() or value.extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() or value.matches('^[0-9]{12}$'))

78. Patient.identifier:CCCD.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

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

80. Patient.identifier:CCCD.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

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

82. Patient.identifier:CCCD.use

Definition

The purpose of this identifier.

Short usual | official | temp | secondary | old (If known)

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control 0..1

The codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

84. Patient.identifier:CCCD.type

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Short Description of identifier

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control 0..1

Unless not suitable, these codes SHALL be taken from Identifier Type Codes
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Is Modifier false

Summary true

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value { "coding" : [{ "system" : "http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs", "code" : "CCCD" }] }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

86. Patient.identifier:CCCD.system

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Short The namespace for the identifier value

Comments

Identifier.system is always case sensitive.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Value http://fhir.hl7.org.vn/core/sid/cccd

Example General: http://www.acme.com/identifiers/patient

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

88. Patient.identifier:CCCD.value

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Short Số CCCD 12 chữ số

Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control 1..1

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: 123456

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

90. Patient.identifier:CCCD.period

Definition

Time period during which identifier is/was valid for use.

Short Time period when id is/was valid for use

Control 0..1

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

92. Patient.identifier:CCCD.assigner

Definition

Organization that issued/manages the identifier.

Short Organization that issued id (may be just text)

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control 0..1

Type Reference(Organization)

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

94. Patient.identifier:BHYT

Slice Name BHYT

Definition

Số thẻ BHYT — hỗ trợ 3 format: CCCD 12 số (từ 15/8/2025 per NĐ 188/2025), mã BHXH 10 số (từ 01/4/2021), hoặc 15 ký tự legacy. Cả 3 format hiện được duy trì song song

Short Số thẻ BHYT

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..1

Is Modifier false

Must Support true

Summary true

Requirements

Patients are almost always assigned specific numerical identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

96. Patient.identifier:BHYT.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

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

98. Patient.identifier:BHYT.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

100. Patient.identifier:BHYT.use

Definition

The purpose of this identifier.

Short usual | official | temp | secondary | old (If known)

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control 0..1

The codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

102. Patient.identifier:BHYT.type

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Short Description of identifier

Comments

Control 0..1

Unless not suitable, these codes SHALL be taken from Identifier Type Codes
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Is Modifier false

Summary true

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value { "coding" : [{ "system" : "http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs", "code" : "BHYT" }] }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

104. Patient.identifier:BHYT.system

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Short The namespace for the identifier value

Comments

Identifier.system is always case sensitive.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Value http://fhir.hl7.org.vn/core/sid/bhyt

Example General: http://www.acme.com/identifiers/patient

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

106. Patient.identifier:BHYT.value

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Short Số thẻ BHYT

Comments

Control 1..1

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: 123456

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

108. Patient.identifier:BHYT.period

Definition

Time period during which identifier is/was valid for use.

Short Time period when id is/was valid for use

Control 0..1

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

110. Patient.identifier:BHYT.assigner

Definition

Organization that issued/manages the identifier.

Short Organization that issued id (may be just text)

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control 0..1

Type Reference(Organization)

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

112. Patient.identifier:BHXH

Slice Name BHXH

Definition

Mã số bảo hiểm xã hội 10 chữ số do BHXH Việt Nam cấp, thường còn tồn tại song song với CCCD trong hồ sơ BHYT/EMR

Short Mã số BHXH

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..1

Is Modifier false

Must Support true

Summary true

Requirements

Patients are almost always assigned specific numerical identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

114. Patient.identifier:BHXH.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

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

116. Patient.identifier:BHXH.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

118. Patient.identifier:BHXH.use

Definition

The purpose of this identifier.

Short usual | official | temp | secondary | old (If known)

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control 0..1

The codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

120. Patient.identifier:BHXH.type

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Short Description of identifier

Comments

Control 0..1

Unless not suitable, these codes SHALL be taken from Identifier Type Codes
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Is Modifier false

Summary true

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value { "coding" : [{ "system" : "http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs", "code" : "BHXH" }] }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

122. Patient.identifier:BHXH.system

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Short The namespace for the identifier value

Comments

Identifier.system is always case sensitive.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Value http://fhir.hl7.org.vn/core/sid/bhxh

Example General: http://www.acme.com/identifiers/patient

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

124. Patient.identifier:BHXH.value

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Short Mã số BHXH 10 chữ số

Comments

Control 1..1

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: 123456

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

126. Patient.identifier:BHXH.period

Definition

Time period during which identifier is/was valid for use.

Short Time period when id is/was valid for use

Control 0..1

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

128. Patient.identifier:BHXH.assigner

Definition

Organization that issued/manages the identifier.

Short Organization that issued id (may be just text)

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control 0..1

Type Reference(Organization)

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

130. Patient.identifier:GKS

Slice Name GKS

Definition

Số Giấy khai sinh phục vụ hồ sơ trẻ em, sơ sinh hoặc đối soát dân cư khi chưa có CCCD. Có thể dùng như định danh thay thế hợp lệ khi CCCD chưa hiện diện

Short Số Giấy khai sinh

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..1

Is Modifier false

Must Support true

Summary true

Requirements

Patients are almost always assigned specific numerical identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

132. Patient.identifier:GKS.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

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

134. Patient.identifier:GKS.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

136. Patient.identifier:GKS.use

Definition

The purpose of this identifier.

Short usual | official | temp | secondary | old (If known)

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control 0..1

The codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

138. Patient.identifier:GKS.type

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Short Description of identifier

Comments

Control 0..1

Unless not suitable, these codes SHALL be taken from Identifier Type Codes
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Is Modifier false

Summary true

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value { "coding" : [{ "system" : "http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs", "code" : "GKS" }] }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

140. Patient.identifier:GKS.system

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Short The namespace for the identifier value

Comments

Identifier.system is always case sensitive.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Value http://fhir.hl7.org.vn/core/sid/gks

Example General: http://www.acme.com/identifiers/patient

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

142. Patient.identifier:GKS.value

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Short Số Giấy khai sinh

Comments

Control 1..1

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: 123456

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

144. Patient.identifier:GKS.period

Definition

Time period during which identifier is/was valid for use.

Short Time period when id is/was valid for use

Control 0..1

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

146. Patient.identifier:GKS.assigner

Definition

Organization that issued/manages the identifier.

Short Organization that issued id (may be just text)

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control 0..1

Type Reference(Organization)

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

148. Patient.identifier:VNEID

Slice Name VNEID

Definition

Tài khoản định danh điện tử quốc gia trên ứng dụng VNeID do Bộ Công an quản lý. Dữ liệu VNeID là dữ liệu cá nhân nhạy cảm theo NĐ 356/2025/NĐ-CP

Short Tài khoản định danh điện tử VNeID

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..1

Is Modifier false

Must Support true

Summary true

Requirements

Patients are almost always assigned specific numerical identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

150. Patient.identifier:VNEID.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

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

152. Patient.identifier:VNEID.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

154. Patient.identifier:VNEID.use

Definition

The purpose of this identifier.

Short usual | official | temp | secondary | old (If known)

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control 0..1

The codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

156. Patient.identifier:VNEID.type

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Short Description of identifier

Comments

Control 0..1

Unless not suitable, these codes SHALL be taken from Identifier Type Codes
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Is Modifier false

Summary true

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value { "coding" : [{ "system" : "http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs", "code" : "VNEID" }] }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

158. Patient.identifier:VNEID.system

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Short The namespace for the identifier value

Comments

Identifier.system is always case sensitive.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Value http://fhir.hl7.org.vn/core/sid/vneid

Example General: http://www.acme.com/identifiers/patient

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

160. Patient.identifier:VNEID.value

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Short Mã/tài khoản VNeID

Comments

Control 1..1

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: 123456

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

162. Patient.identifier:VNEID.period

Definition

Time period during which identifier is/was valid for use.

Short Time period when id is/was valid for use

Control 0..1

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

164. Patient.identifier:VNEID.assigner

Definition

Organization that issued/manages the identifier.

Short Organization that issued id (may be just text)

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control 0..1

Type Reference(Organization)

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

166. Patient.identifier:MRN

Slice Name MRN

Definition

Mã bệnh nhân nội bộ do cơ sở y tế cấp

Short Mã bệnh nhân (MRN)

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..*

Is Modifier false

Must Support true

Summary true

Requirements

Patients are almost always assigned specific numerical identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

168. Patient.identifier:MRN.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

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

170. Patient.identifier:MRN.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

172. Patient.identifier:MRN.use

Definition

The purpose of this identifier.

Short usual | official | temp | secondary | old (If known)

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control 0..1

The codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

174. Patient.identifier:MRN.type

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Short Description of identifier

Comments

Control 0..1

Unless not suitable, these codes SHALL be taken from Identifier Type Codes
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Is Modifier false

Summary true

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value { "coding" : [{ "system" : "http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs", "code" : "MRN" }] }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

176. Patient.identifier:MRN.system

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Short The namespace for the identifier value

Comments

Identifier.system is always case sensitive.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Value http://fhir.hl7.org.vn/core/sid/mrn

Example General: http://www.acme.com/identifiers/patient

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

178. Patient.identifier:MRN.value

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Short Mã bệnh nhân nội bộ

Comments

Control 1..1

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: 123456

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

180. Patient.identifier:MRN.period

Definition

Time period during which identifier is/was valid for use.

Short Time period when id is/was valid for use

Control 0..1

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

182. Patient.identifier:MRN.assigner

Definition

Organization that issued/manages the identifier.

Short Organization that issued id (may be just text)

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control 0..1

Type Reference(Organization)

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

184. Patient.identifier:HC

Slice Name HC

Definition

Số hộ chiếu dùng cho người nước ngoài hoặc trường hợp chưa có CCCD. Khi dùng hộ chiếu như định danh thay thế, slice CCCD vẫn hiện diện với data-absent-reason

Short Số hộ chiếu

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..1

Is Modifier false

Must Support true

Summary true

Requirements

Patients are almost always assigned specific numerical identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

186. Patient.identifier:HC.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

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

188. Patient.identifier:HC.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

190. Patient.identifier:HC.use

Definition

The purpose of this identifier.

Short usual | official | temp | secondary | old (If known)

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control 0..1

The codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

192. Patient.identifier:HC.type

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Short Description of identifier

Comments

Control 0..1

Unless not suitable, these codes SHALL be taken from Identifier Type Codes
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Is Modifier false

Summary true

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value { "coding" : [{ "system" : "http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs", "code" : "HC" }] }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

194. Patient.identifier:HC.system

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Short The namespace for the identifier value

Comments

Identifier.system is always case sensitive.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Value http://fhir.hl7.org.vn/core/sid/passport

Example General: http://www.acme.com/identifiers/patient

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

196. Patient.identifier:HC.value

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Short The value that is unique

Comments

Control 1..1

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: 123456

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

198. Patient.identifier:HC.period

Definition

Time period during which identifier is/was valid for use.

Short Time period when id is/was valid for use

Control 0..1

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

200. Patient.identifier:HC.assigner

Definition

Organization that issued/manages the identifier.

Short Organization that issued id (may be just text)

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control 0..1

Type Reference(Organization)

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

202. Patient.active

Definition

Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.

It is often used to filter patient lists to exclude inactive patients

Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

Short Whether this patient's record is in active use

Comments

If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.

Control 0..1

boolean

Is Modifier true because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Need to be able to mark a patient record as not to be used because it was created in error.

Meaning if Missing This resource is generally assumed to be active if no value is provided for the active element

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

204. Patient.name

Definition

A name associated with the individual.

Short Họ tên bệnh nhân

Comments

A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

Control 1..*

HumanName

Is Modifier false

Must Support true

Summary true

Requirements

Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

206. Patient.name.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

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

208. Patient.name.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

210. Patient.name.use

Definition

Identifies the purpose for this name.

Comments

Applications can assume that a name is current unless it explicitly says that it is temporary or old.

Control 0..1

The codes SHALL be taken from NameUse
(required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

The use of a human name.

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name 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 the appropriate name for a particular context of use to be selected from among a set of names.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

212. Patient.name.text

Definition

Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

Short Họ tên đầy đủ (khuyến khích dùng cho tên VN)

Comments

Can provide both a text representation and parts. Applications updating a name 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

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.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

214. Patient.name.family

Definition

The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

Short Họ

Comments

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

Control 0..1

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 surname

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

216. Patient.name.given

Definition

Given name.

Short Tên đệm và Tên

Comments

If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

Control 0..*

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 first name, middle name

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

218. Patient.name.prefix

Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

Short Parts that come before the name

Control 0..*

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()))

220. Patient.name.suffix

Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

Short Parts that come after the name

Control 0..*

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()))

222. Patient.name.period

Definition

Indicates the period of time when this name was valid for the named person.

Short Time period when name was/is in use

Control 0..1

Is Modifier false

Summary true

Requirements

Allows names to be placed in historical context.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

224. Patient.telecom

Definition

A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

Short Thông tin liên lạc (SĐT, email)

Comments

A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

Control 0..*

ContactPoint

Is Modifier false

Must Support true

Summary true

Requirements

People have (primary) ways to contact them in some way such as phone, email.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

226. Patient.gender

Definition

Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.

Short Giới tính

Comments

The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.

Control 1..1

The codes SHALL be taken from AdministrativeGender
(required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

The gender of a person used for administrative purposes.

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

Needed for identification of the individual, in combination with (at least) name and birth date.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

228. Patient.birthDate

Definition

The date of birth for the individual.

Short Ngày sinh

Comments

At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).

Control 0..1

date

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

Age of the individual drives many clinical processes.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

LOINC Code 21112-8

230. Patient.deceased[x]

Definition

Indicates if the individual is deceased or not.

Short Indicates if the individual is deceased or not

Comments

If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

Control 0..1

Type Choice of: boolean, dateTime

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier true because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

232. Patient.address

Definition

An address for the individual.

Short Địa chỉ theo ĐVHC mới (NQ 202/2025)

Comments

Patient may have multiple addresses with different uses or applicable periods.

Control 0..*

Type Address(Địa chỉ VN Core — VN Core Address Profile)

Is Modifier false

Must Support true

Summary true

Requirements

May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

234. Patient.maritalStatus

Definition

This field contains a patient's most recent marital (civil) status.

Short Marital (civil) status of a patient

Control 0..1

Unless not suitable, these codes SHALL be taken from Marital Status Codes
(extensible to http://hl7.org/fhir/ValueSet/marital-status|4.0.1)

The domestic partnership status of a person.

Is Modifier false

Summary false

Requirements

Most, if not all systems capture it.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

236. Patient.multipleBirth[x]

Definition

Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

Short Whether patient is part of a multiple birth

Comments

Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

Control 0..1

Type Choice of: boolean, integer

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Requirements

For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

238. Patient.photo

Definition

Image of the patient.

Short Image of the patient

Comments

Guidelines:

Use id photos, not clinical photos.
Limit dimensions to thumbnail.
Keep byte count low to ease resource updates.

Control 0..*

Attachment

Is Modifier false

Summary false

Requirements

Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

240. Patient.contact

Definition

Dùng cho cha, mẹ, người giám hộ hoặc người liên hệ khẩn cấp. Đây là mô hình gọn theo base FHIR; khi cần hồ sơ độc lập và định danh đầy đủ thì dùng RelatedPerson

Short Người liên hệ/cha mẹ/người giám hộ

Comments

Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

Control 0..*

BackboneElement

Is Modifier false

Must Support true

Summary false

Requirements

Need to track people you can contact about the patient.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())

242. Patient.contact.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

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

244. Patient.contact.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

246. Patient.contact.modifierExtension

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

248. Patient.contact.relationship

Definition

The nature of the relationship between the patient and the contact person.

Short Quan hệ với bệnh nhân

Control 0..*

Unless not suitable, these codes SHALL be taken from PatientContactRelationship
(extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1)

The nature of the relationship between a patient and a contact person for that patient.

Is Modifier false

Must Support true

Summary false

Requirements

Used to determine which contact person is the most relevant to approach, depending on circumstances.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

250. Patient.contact.name

Definition

A name associated with the contact person.

Short Tên người liên hệ/người giám hộ

Control 0..1

HumanName

Is Modifier false

Must Support true

Summary false

Requirements

Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

252. Patient.contact.telecom

Definition

A contact detail for the person, e.g. a telephone number or an email address.

Short Thông tin liên lạc của cha/mẹ/người giám hộ

Comments

Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

Control 0..*

ContactPoint

Is Modifier false

Must Support true

Summary false

Requirements

People have (primary) ways to contact them in some way such as phone, email.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

254. Patient.contact.address

Definition

Address for the contact person.

Short Địa chỉ người liên hệ/người giám hộ

Control 0..1

Type Address(Địa chỉ VN Core — VN Core Address Profile)

Is Modifier false

Summary false

Requirements

Need to keep track where the contact person can be contacted per postal mail or visited.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

256. Patient.contact.gender

Definition

Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.

Short male | female | other | unknown

Control 0..1

The codes SHALL be taken from AdministrativeGender
(required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

The gender of a person used for administrative purposes.

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Requirements

Needed to address the person correctly.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

258. Patient.contact.organization

Definition

Organization on behalf of which the contact is acting or for which the contact is working.

Short Organization that is associated with the contact

Control 0..1
This element is affected by the following invariants: pat-1

Type Reference(Organization)

Is Modifier false

Summary false

Requirements

For guardians or business related contacts, the organization is relevant.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

260. Patient.contact.period

Definition

The period during which this contact person or organization is valid to be contacted relating to this patient.

Short The period during which this contact person or organization is valid to be contacted relating to this patient

Control 0..1

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

262. Patient.communication

Definition

A language which may be used to communicate with the patient about his or her health.

Short A language which may be used to communicate with the patient about his or her health

Comments

If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

Control 0..*

BackboneElement

Is Modifier false

Summary false

Requirements

If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

264. Patient.communication.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

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

266. Patient.communication.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

268. Patient.communication.modifierExtension

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

270. Patient.communication.language

Definition

The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.

Short The language which can be used to communicate with the patient about his or her health

Comments

The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

Control 1..1

The codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

A human language.

Additional Bindings

Purpose

Is Modifier false

Summary false

Requirements

Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

272. Patient.communication.preferred

Definition

Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

Short Language preference indicator

Comments

This language is specifically identified for communicating healthcare information.

Control 0..1

boolean

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Requirements

People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

274. Patient.generalPractitioner

Definition

Patient's nominated care provider.

Short Patient's nominated primary care provider

Comments

This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues.

Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.

Control 0..*

Type Reference(Organization, Practitioner, PractitionerRole)

Is Modifier false

Summary false

Alternate Names careProvider

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

276. Patient.managingOrganization

Definition

Organization that is the custodian of the patient record.

Short Organization that is the custodian of the patient record

Comments

There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).

Control 0..1

Type Reference(Organization)

Is Modifier false

Summary true

Requirements

Need to know who recognizes this patient record, manages and updates it.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

278. Patient.link

Definition

Link to another patient resource that concerns the same actual patient.

Short Link to another patient resource that concerns the same actual person

Comments

There is no assumption that linked patient records have mutual links.

Control 0..*

BackboneElement

Is Modifier true because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'

Summary true

Requirements

There are multiple use cases:

Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
Distribution of patient information across multiple servers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

280. Patient.link.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

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

282. Patient.link.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

284. Patient.link.modifierExtension

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

286. Patient.link.other

Definition

The other patient resource that the link refers to.

Short The other patient or related person resource that the link refers to

Comments

Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.

Control 1..1

Type Reference(Patient, RelatedPerson)

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

288. Patient.link.type

Definition

The type of link between this patient resource and another patient resource.

Short replaced-by | replaces | refer | seealso

Control 1..1

The codes SHALL be taken from LinkType
(required to http://hl7.org/fhir/ValueSet/link-type|4.0.1)

The type of link between this patient resource and another patient resource.