NHDR Implementation Guide Release 1.0
0.1.0 - ci-build

NHDR Implementation Guide Release 1.0, published by NHDR. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/PROJ-PHILHEALTH-EA-NHDR/nhdr-fhir-ig-review-project-2/ and changes regularly. See the Directory of published versions

## Logical Model: PatientModel - Detailed Descriptions

Draft as of 2026-04-15

Definitions for the PatientModel logical model.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

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

0. PatientModel
Definition | Sample Logical Model
Short | Minimum Required Patient Data
Control | 0..*
Is Modifier | false
Logical Model | Instances of this logical model are not marked to be the target of a Reference
2. PatientModel.PhilHealthID
Definition | PhilHealth Identification Number
Short | PhilHealth Identification Number
Control | 1..1
Type | Identifier
4. PatientModel.name
Definition | Test Name
Short | Test Name
Control | 0..*
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. PatientModel.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
8. PatientModel.name.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `PatientModel.name.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
10. PatientModel.name.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 | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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, modifiers
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())
12. PatientModel.name.familyName
Definition | Surname
Short | Surname
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
14. PatientModel.name.firstName
Definition | First Name
Short | First Name
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
16. PatientModel.name.middleName
Definition | Middle Name
Short | Middle Name
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
18. PatientModel.sex
Definition | Sex at Birth
Short | Sex at Birth
Control | 0..1
Type | CodeableConcept
20. PatientModel.signature
Definition | Signature
Short | Signature
Control | 0..*
Type | Signature

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

0. PatientModel
Definition | Sample Logical Model
Short | Minimum Required Patient Data
Logical Model | Instances of this logical model are not marked to be the target of a Reference
2. PatientModel.PhilHealthID
Definition | PhilHealth Identification Number
Short | PhilHealth Identification Number
Control | 1..1
Type | Identifier
4. PatientModel.name
Definition | Test Name
Short | Test Name
Control | 0..*
Type | BackboneElement
6. PatientModel.name.familyName
Definition | Surname
Short | Surname
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
8. PatientModel.name.firstName
Definition | First Name
Short | First Name
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
10. PatientModel.name.middleName
Definition | Middle Name
Short | Middle Name
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
12. PatientModel.sex
Definition | Sex at Birth
Short | Sex at Birth
Control | 0..1
Type | CodeableConcept
14. PatientModel.signature
Definition | Signature
Short | Signature
Control | 0..*
Type | Signature

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

0. PatientModel
Definition | Sample Logical Model
Short | Minimum Required Patient Data
Control | 0..*
Is Modifier | false
Logical Model | Instances of this logical model are not marked to be the target of a Reference
2. PatientModel.PhilHealthID
Definition | PhilHealth Identification Number
Short | PhilHealth Identification Number
Control | 1..1
Type | Identifier
4. PatientModel.name
Definition | Test Name
Short | Test Name
Control | 0..*
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. PatientModel.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
8. PatientModel.name.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PatientModel.name.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
10. PatientModel.name.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 | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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, modifiers
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()`)
12. PatientModel.name.familyName
Definition | Surname
Short | Surname
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
14. PatientModel.name.firstName
Definition | First Name
Short | First Name
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
16. PatientModel.name.middleName
Definition | Middle Name
Short | Middle Name
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
18. PatientModel.sex
Definition | Sex at Birth
Short | Sex at Birth
Control | 0..1
Type | CodeableConcept
20. PatientModel.signature
Definition | Signature
Short | Signature
Control | 0..*
Type | Signature