VN Core FHIR Implementation Guide — Bộ Hướng dẫn Triển khai FHIR Cốt lõi cho Việt Nam
0.1.0 - STU1 Draft
VN Core FHIR Implementation Guide — Bộ Hướng dẫn Triển khai FHIR Cốt lõi cho Việt Nam
0.1.0 - STU1 Draft
VN Core FHIR Implementation Guide — Bộ Hướng dẫn Triển khai FHIR Cốt lõi cho Việt Nam - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://fhir.hl7.org.vn/core/StructureDefinition/vn-core-patient | Version: 0.1.0 | |||
| Draft as of 2026-03-21 | Computable Name: VNCorePatient | |||
Profile Patient cho Việt Nam. Bao gồm identifier slicing (CCCD, BHYT, MRN), extensions dân tộc/tôn giáo, và ràng buộc địa chỉ theo VNCoreAddress. Căn cứ: TT 13/2025/TT-BYT (bệnh án điện tử), Luật Căn cước 2023, Luật BHYT.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Patient |
0..* | Patient | Information about an individual or animal receiving health care services | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:ethnicity |
0..1 | CodeableConcept | Dân tộc URL: http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-ethnicity Binding: Danh mục Dân tộc Việt Nam — Vietnam Ethnicity ValueSet (required) | |
| extension:religion |
0..1 | CodeableConcept | Tôn giáo URL: http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-religion Binding: Danh mục Tôn giáo Việt Nam — Vietnam Religion ValueSet (required) | |
 extension:occupation |
0..1 | CodeableConcept | Nghề nghiệp URL: http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-occupation Binding: Nghề nghiệp — VN Occupation ValueSet (extensible) | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 Slices for identifier |
SΣ | 1..* | Identifier | Định danh bệnh nhân (CCCD, BHYT, MRN...) Slice: Unordered, Open by value:system |
 identifier:CCCD |
SΣC | 0..1 | Identifier | Số CCCD (Căn cước công dân) Constraints: vn-cccd-format |
  use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
  type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
 id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
 coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: CCCD | |
| display |
0..1 | string | Representation defined by the system | |
 userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.hl7.org.vn/core/sid/cccd |
 value |
SΣ | 1..1 | string | Số CCCD 12 chữ số Example General: 123456 |
| identifier:BHYT |
SΣ | 0..1 | Identifier | Số thẻ BHYT |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: BHYT | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.hl7.org.vn/core/sid/bhyt |
| value |
SΣ | 1..1 | string | Số thẻ BHYT Example General: 123456 |
 identifier:MRN |
SΣ | 0..* | Identifier | Mã bệnh nhân (MRN) |
 use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: MRN | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.hl7.org.vn/core/sid/mrn |
| value |
SΣ | 1..1 | string | Mã bệnh nhân nội bộ Example General: 123456 |
| active |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| name |
SΣ | 1..* | HumanName | Họ tên bệnh nhân |
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
| text |
SΣ | 0..1 | string | Họ tên đầy đủ (khuyến khích dùng cho tên VN) |
| family |
SΣ | 0..1 | string | Họ |
| given |
SΣ | 0..* | string | Tên đệm và Tên This repeating element order: Given Names appear in the correct order for presenting the name |
| telecom |
SΣ | 0..* | ContactPoint | Thông tin liên lạc (SĐT, email) |
| gender |
SΣ | 1..1 | code | Giới tính Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| birthDate |
SΣ | 0..1 | date | Ngày sinh |
 deceased[x] |
?!Σ | 0..1 | Indicates if the individual is deceased or not | |
| deceasedBoolean |
boolean | |||
| deceasedDateTime |
dateTime | |||
| address |
SΣ | 0..* | VNCoreAddress | Địa chỉ theo ĐVHC mới (NQ 202/2025) |
 link |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 other |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.identifier:CCCD.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:CCCD.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Patient.identifier:BHYT.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:BHYT.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Patient.identifier:MRN.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:MRN.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Patient | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| vn-cccd-format | error | Patient.identifier:CCCD | Số CCCD phải đúng 12 chữ số (Luật Căn cước 2023, Điều 20) |
value.empty() or value.matches('^[0-9]{12}$')
|
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Patient |
0..* | Patient | Information about an individual or animal receiving health care services | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:ethnicity |
0..1 | CodeableConcept | Dân tộc URL: http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-ethnicity Binding: Danh mục Dân tộc Việt Nam — Vietnam Ethnicity ValueSet (required) | |
| extension:religion |
0..1 | CodeableConcept | Tôn giáo URL: http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-religion Binding: Danh mục Tôn giáo Việt Nam — Vietnam Religion ValueSet (required) | |
| extension:occupation |
0..1 | CodeableConcept | Nghề nghiệp URL: http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-occupation Binding: Nghề nghiệp — VN Occupation ValueSet (extensible) | |
| Slices for identifier |
S | 1..* | Identifier | Định danh bệnh nhân (CCCD, BHYT, MRN...) Slice: Unordered, Open by value:system |
| identifier:CCCD |
SC | 0..1 | Identifier | Số CCCD (Căn cước công dân) Constraints: vn-cccd-format |
 type |
0..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: CCCD | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.hl7.org.vn/core/sid/cccd | |
| value |
S | 1..1 | string | Số CCCD 12 chữ số |
| identifier:BHYT |
S | 0..1 | Identifier | Số thẻ BHYT |
| type |
0..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: BHYT | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.hl7.org.vn/core/sid/bhyt | |
| value |
S | 1..1 | string | Số thẻ BHYT |
| identifier:MRN |
S | 0..* | Identifier | Mã bệnh nhân (MRN) |
| type |
0..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: MRN | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.hl7.org.vn/core/sid/mrn | |
| value |
S | 1..1 | string | Mã bệnh nhân nội bộ |
| name |
S | 1..* | HumanName | Họ tên bệnh nhân |
| text |
S | 0..1 | string | Họ tên đầy đủ (khuyến khích dùng cho tên VN) |
| family |
S | 0..1 | string | Họ |
| given |
S | 0..* | string | Tên đệm và Tên |
| telecom |
S | 0..* | ContactPoint | Thông tin liên lạc (SĐT, email) |
| gender |
S | 1..1 | code | Giới tính |
| birthDate |
S | 0..1 | date | Ngày sinh |
| address |
S | 0..* | VNCoreAddress | Địa chỉ theo ĐVHC mới (NQ 202/2025) |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| vn-cccd-format | error | Patient.identifier:CCCD | Số CCCD phải đúng 12 chữ số (Luật Căn cước 2023, Điều 20) |
value.empty() or value.matches('^[0-9]{12}$')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Patient |
0..* | Patient | Information about an individual or animal receiving health care services | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:ethnicity |
0..1 | CodeableConcept | Dân tộc URL: http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-ethnicity Binding: Danh mục Dân tộc Việt Nam — Vietnam Ethnicity ValueSet (required) | |||||
| extension:religion |
0..1 | CodeableConcept | Tôn giáo URL: http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-religion Binding: Danh mục Tôn giáo Việt Nam — Vietnam Religion ValueSet (required) | |||||
| extension:occupation |
0..1 | CodeableConcept | Nghề nghiệp URL: http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-occupation Binding: Nghề nghiệp — VN Occupation ValueSet (extensible) | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
SΣ | 1..* | Identifier | Định danh bệnh nhân (CCCD, BHYT, MRN...) Slice: Unordered, Open by value:system | ||||
| identifier:CCCD |
SΣC | 0..1 | Identifier | Số CCCD (Căn cước công dân) Constraints: vn-cccd-format | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: CCCD | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.hl7.org.vn/core/sid/cccd | ||||
| value |
SΣ | 1..1 | string | Số CCCD 12 chữ số Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:BHYT |
SΣ | 0..1 | Identifier | Số thẻ BHYT | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: BHYT | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.hl7.org.vn/core/sid/bhyt | ||||
| value |
SΣ | 1..1 | string | Số thẻ BHYT Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:MRN |
SΣ | 0..* | Identifier | Mã bệnh nhân (MRN) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: MRN | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.hl7.org.vn/core/sid/mrn | ||||
| value |
SΣ | 1..1 | string | Mã bệnh nhân nội bộ Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
| name |
SΣ | 1..* | HumanName | Họ tên bệnh nhân | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
| text |
SΣ | 0..1 | string | Họ tên đầy đủ (khuyến khích dùng cho tên VN) | ||||
| family |
SΣ | 0..1 | string | Họ | ||||
| given |
SΣ | 0..* | string | Tên đệm và Tên This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
| telecom |
SΣ | 0..* | ContactPoint | Thông tin liên lạc (SĐT, email) | ||||
| gender |
SΣ | 1..1 | code | Giới tính Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate |
SΣ | 0..1 | date | Ngày sinh | ||||
| deceased[x] |
?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
| deceasedBoolean |
boolean | |||||||
| deceasedDateTime |
dateTime | |||||||
| address |
SΣ | 0..* | VNCoreAddress | Địa chỉ theo ĐVHC mới (NQ 202/2025) | ||||
| maritalStatus |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
| multipleBirth[x] |
0..1 | Whether patient is part of a multiple birth | ||||||
| multipleBirthBoolean |
boolean | |||||||
| multipleBirthInteger |
integer | |||||||
| photo |
0..* | Attachment | Image of the patient | |||||
| contact |
C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| relationship |
0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
| name |
0..1 | HumanName | A name associated with the contact person | |||||
| telecom |
0..* | ContactPoint | A contact detail for the person | |||||
| address |
0..1 | Address | Address for the contact person | |||||
| gender |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| organization |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
| period |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
| communication |
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language |
1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
| preferred |
0..1 | boolean | Language preference indicator | |||||
| generalPractitioner |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
| managingOrganization |
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
| link |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| other |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
| type |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Patient.identifier:CCCD.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:CCCD.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Patient.identifier:BHYT.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:BHYT.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Patient.identifier:MRN.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:MRN.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Patient.maritalStatus | Base | extensible | MaritalStatus | 📍4.0.1 | FHIR Std. |
| Patient.contact.relationship | Base | extensible | Patient Contact Relationship | 📍4.0.1 | FHIR Std. |
| Patient.contact.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Patient.communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Patient | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| pat-1 | error | Patient.contact | 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()
|
| vn-cccd-format | error | Patient.identifier:CCCD | Số CCCD phải đúng 12 chữ số (Luật Căn cước 2023, Điều 20) |
value.empty() or value.matches('^[0-9]{12}$')
|
This structure is derived from Patient
Summary
Mandatory: 3 elements(6 nested mandatory elements)
Must-Support: 15 elements
Fixed: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Patient |
0..* | Patient | Information about an individual or animal receiving health care services | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:ethnicity |
0..1 | CodeableConcept | Dân tộc URL: http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-ethnicity Binding: Danh mục Dân tộc Việt Nam — Vietnam Ethnicity ValueSet (required) | |
| extension:religion |
0..1 | CodeableConcept | Tôn giáo URL: http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-religion Binding: Danh mục Tôn giáo Việt Nam — Vietnam Religion ValueSet (required) | |
| extension:occupation |
0..1 | CodeableConcept | Nghề nghiệp URL: http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-occupation Binding: Nghề nghiệp — VN Occupation ValueSet (extensible) | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
SΣ | 1..* | Identifier | Định danh bệnh nhân (CCCD, BHYT, MRN...) Slice: Unordered, Open by value:system |
| identifier:CCCD |
SΣC | 0..1 | Identifier | Số CCCD (Căn cước công dân) Constraints: vn-cccd-format |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: CCCD | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.hl7.org.vn/core/sid/cccd |
| value |
SΣ | 1..1 | string | Số CCCD 12 chữ số Example General: 123456 |
| identifier:BHYT |
SΣ | 0..1 | Identifier | Số thẻ BHYT |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: BHYT | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.hl7.org.vn/core/sid/bhyt |
| value |
SΣ | 1..1 | string | Số thẻ BHYT Example General: 123456 |
| identifier:MRN |
SΣ | 0..* | Identifier | Mã bệnh nhân (MRN) |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: MRN | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.hl7.org.vn/core/sid/mrn |
| value |
SΣ | 1..1 | string | Mã bệnh nhân nội bộ Example General: 123456 |
| active |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| name |
SΣ | 1..* | HumanName | Họ tên bệnh nhân |
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
| text |
SΣ | 0..1 | string | Họ tên đầy đủ (khuyến khích dùng cho tên VN) |
| family |
SΣ | 0..1 | string | Họ |
| given |
SΣ | 0..* | string | Tên đệm và Tên This repeating element order: Given Names appear in the correct order for presenting the name |
| telecom |
SΣ | 0..* | ContactPoint | Thông tin liên lạc (SĐT, email) |
| gender |
SΣ | 1..1 | code | Giới tính Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| birthDate |
SΣ | 0..1 | date | Ngày sinh |
| deceased[x] |
?!Σ | 0..1 | Indicates if the individual is deceased or not | |
| deceasedBoolean |
boolean | |||
| deceasedDateTime |
dateTime | |||
| address |
SΣ | 0..* | VNCoreAddress | Địa chỉ theo ĐVHC mới (NQ 202/2025) |
| link |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| other |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.identifier:CCCD.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:CCCD.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Patient.identifier:BHYT.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:BHYT.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Patient.identifier:MRN.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:MRN.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Patient | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| vn-cccd-format | error | Patient.identifier:CCCD | Số CCCD phải đúng 12 chữ số (Luật Căn cước 2023, Điều 20) |
value.empty() or value.matches('^[0-9]{12}$')
|
Differential View
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Patient |
0..* | Patient | Information about an individual or animal receiving health care services | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:ethnicity |
0..1 | CodeableConcept | Dân tộc URL: http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-ethnicity Binding: Danh mục Dân tộc Việt Nam — Vietnam Ethnicity ValueSet (required) | |
| extension:religion |
0..1 | CodeableConcept | Tôn giáo URL: http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-religion Binding: Danh mục Tôn giáo Việt Nam — Vietnam Religion ValueSet (required) | |
| extension:occupation |
0..1 | CodeableConcept | Nghề nghiệp URL: http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-occupation Binding: Nghề nghiệp — VN Occupation ValueSet (extensible) | |
| Slices for identifier |
S | 1..* | Identifier | Định danh bệnh nhân (CCCD, BHYT, MRN...) Slice: Unordered, Open by value:system |
| identifier:CCCD |
SC | 0..1 | Identifier | Số CCCD (Căn cước công dân) Constraints: vn-cccd-format |
| type |
0..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: CCCD | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.hl7.org.vn/core/sid/cccd | |
| value |
S | 1..1 | string | Số CCCD 12 chữ số |
| identifier:BHYT |
S | 0..1 | Identifier | Số thẻ BHYT |
| type |
0..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: BHYT | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.hl7.org.vn/core/sid/bhyt | |
| value |
S | 1..1 | string | Số thẻ BHYT |
| identifier:MRN |
S | 0..* | Identifier | Mã bệnh nhân (MRN) |
| type |
0..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: MRN | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.hl7.org.vn/core/sid/mrn | |
| value |
S | 1..1 | string | Mã bệnh nhân nội bộ |
| name |
S | 1..* | HumanName | Họ tên bệnh nhân |
| text |
S | 0..1 | string | Họ tên đầy đủ (khuyến khích dùng cho tên VN) |
| family |
S | 0..1 | string | Họ |
| given |
S | 0..* | string | Tên đệm và Tên |
| telecom |
S | 0..* | ContactPoint | Thông tin liên lạc (SĐT, email) |
| gender |
S | 1..1 | code | Giới tính |
| birthDate |
S | 0..1 | date | Ngày sinh |
| address |
S | 0..* | VNCoreAddress | Địa chỉ theo ĐVHC mới (NQ 202/2025) |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| vn-cccd-format | error | Patient.identifier:CCCD | Số CCCD phải đúng 12 chữ số (Luật Căn cước 2023, Điều 20) |
value.empty() or value.matches('^[0-9]{12}$')
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Patient |
0..* | Patient | Information about an individual or animal receiving health care services | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:ethnicity |
0..1 | CodeableConcept | Dân tộc URL: http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-ethnicity Binding: Danh mục Dân tộc Việt Nam — Vietnam Ethnicity ValueSet (required) | |||||
| extension:religion |
0..1 | CodeableConcept | Tôn giáo URL: http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-religion Binding: Danh mục Tôn giáo Việt Nam — Vietnam Religion ValueSet (required) | |||||
| extension:occupation |
0..1 | CodeableConcept | Nghề nghiệp URL: http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-occupation Binding: Nghề nghiệp — VN Occupation ValueSet (extensible) | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
SΣ | 1..* | Identifier | Định danh bệnh nhân (CCCD, BHYT, MRN...) Slice: Unordered, Open by value:system | ||||
| identifier:CCCD |
SΣC | 0..1 | Identifier | Số CCCD (Căn cước công dân) Constraints: vn-cccd-format | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: CCCD | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.hl7.org.vn/core/sid/cccd | ||||
| value |
SΣ | 1..1 | string | Số CCCD 12 chữ số Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:BHYT |
SΣ | 0..1 | Identifier | Số thẻ BHYT | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: BHYT | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.hl7.org.vn/core/sid/bhyt | ||||
| value |
SΣ | 1..1 | string | Số thẻ BHYT Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:MRN |
SΣ | 0..* | Identifier | Mã bệnh nhân (MRN) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: MRN | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.hl7.org.vn/core/sid/mrn | ||||
| value |
SΣ | 1..1 | string | Mã bệnh nhân nội bộ Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
| name |
SΣ | 1..* | HumanName | Họ tên bệnh nhân | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
| text |
SΣ | 0..1 | string | Họ tên đầy đủ (khuyến khích dùng cho tên VN) | ||||
| family |
SΣ | 0..1 | string | Họ | ||||
| given |
SΣ | 0..* | string | Tên đệm và Tên This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
| telecom |
SΣ | 0..* | ContactPoint | Thông tin liên lạc (SĐT, email) | ||||
| gender |
SΣ | 1..1 | code | Giới tính Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate |
SΣ | 0..1 | date | Ngày sinh | ||||
| deceased[x] |
?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
| deceasedBoolean |
boolean | |||||||
| deceasedDateTime |
dateTime | |||||||
| address |
SΣ | 0..* | VNCoreAddress | Địa chỉ theo ĐVHC mới (NQ 202/2025) | ||||
| maritalStatus |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
| multipleBirth[x] |
0..1 | Whether patient is part of a multiple birth | ||||||
| multipleBirthBoolean |
boolean | |||||||
| multipleBirthInteger |
integer | |||||||
| photo |
0..* | Attachment | Image of the patient | |||||
| contact |
C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| relationship |
0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
| name |
0..1 | HumanName | A name associated with the contact person | |||||
| telecom |
0..* | ContactPoint | A contact detail for the person | |||||
| address |
0..1 | Address | Address for the contact person | |||||
| gender |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| organization |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
| period |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
| communication |
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language |
1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
| preferred |
0..1 | boolean | Language preference indicator | |||||
| generalPractitioner |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
| managingOrganization |
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
| link |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| other |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
| type |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Patient.identifier:CCCD.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:CCCD.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Patient.identifier:BHYT.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:BHYT.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Patient.identifier:MRN.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:MRN.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Patient.maritalStatus | Base | extensible | MaritalStatus | 📍4.0.1 | FHIR Std. |
| Patient.contact.relationship | Base | extensible | Patient Contact Relationship | 📍4.0.1 | FHIR Std. |
| Patient.contact.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Patient.communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Patient | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| pat-1 | error | Patient.contact | 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()
|
| vn-cccd-format | error | Patient.identifier:CCCD | Số CCCD phải đúng 12 chữ số (Luật Căn cước 2023, Điều 20) |
value.empty() or value.matches('^[0-9]{12}$')
|
This structure is derived from Patient
Summary
Mandatory: 3 elements(6 nested mandatory elements)
Must-Support: 15 elements
Fixed: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron