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/UP-Manila-SILab/PhilHealth-NHDR-IG-Review/ and changes regularly. See the Directory of published versions

Logical Model: PatientModel - Detailed Descriptions

Draft as of 2025-10-16

Definitions for the PatientModel logical model.

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

0. PatientModel
Definition

Sample Logical Model

ShortMinimum Required Patient Data
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. PatientModel.PhilHealthID
Definition

PhilHealth Identification Number

ShortPhilHealth Identification Number
Control1..1
TypeIdentifier
4. PatientModel.name
Definition

Test Name

ShortTest Name
Control0..*
TypeBackboneElement
Invariantsele-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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis 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).

    ShortExtensions 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.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    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 Namesextensions, user content, modifiers
    Invariantsele-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

    ShortSurname
    Control1..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    14. PatientModel.name.firstName
    Definition

    First Name

    ShortFirst Name
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    16. PatientModel.name.middleName
    Definition

    Middle Name

    ShortMiddle Name
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    18. PatientModel.sex
    Definition

    Sex at Birth

    ShortSex at Birth
    Control0..1
    TypeCodeableConcept
    20. PatientModel.signature
    Definition

    Signature

    ShortSignature
    Control0..*
    TypeSignature

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

    0. PatientModel
    Definition

    Sample Logical Model

    ShortMinimum Required Patient Data
    Logical ModelInstances of this logical model are not marked to be the target of a Reference
    2. PatientModel.PhilHealthID
    Definition

    PhilHealth Identification Number

    ShortPhilHealth Identification Number
    Control1..1
    TypeIdentifier
    4. PatientModel.name
    Definition

    Test Name

    ShortTest Name
    Control0..*
    TypeBackboneElement
    6. PatientModel.name.familyName
    Definition

    Surname

    ShortSurname
    Control1..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    8. PatientModel.name.firstName
    Definition

    First Name

    ShortFirst Name
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    10. PatientModel.name.middleName
    Definition

    Middle Name

    ShortMiddle Name
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    12. PatientModel.sex
    Definition

    Sex at Birth

    ShortSex at Birth
    Control0..1
    TypeCodeableConcept
    14. PatientModel.signature
    Definition

    Signature

    ShortSignature
    Control0..*
    TypeSignature

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

    0. PatientModel
    Definition

    Sample Logical Model

    ShortMinimum Required Patient Data
    Control0..*
    Is Modifierfalse
    Logical ModelInstances of this logical model are not marked to be the target of a Reference
    2. PatientModel.PhilHealthID
    Definition

    PhilHealth Identification Number

    ShortPhilHealth Identification Number
    Control1..1
    TypeIdentifier
    4. PatientModel.name
    Definition

    Test Name

    ShortTest Name
    Control0..*
    TypeBackboneElement
    Invariantsele-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.

    ShortUnique id for inter-element referencing
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    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.

    ShortAdditional 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.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-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())
    SlicingThis 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).

      ShortExtensions 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.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      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 Namesextensions, user content, modifiers
      Invariantsele-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

      ShortSurname
      Control1..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      14. PatientModel.name.firstName
      Definition

      First Name

      ShortFirst Name
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      16. PatientModel.name.middleName
      Definition

      Middle Name

      ShortMiddle Name
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      18. PatientModel.sex
      Definition

      Sex at Birth

      ShortSex at Birth
      Control0..1
      TypeCodeableConcept
      20. PatientModel.signature
      Definition

      Signature

      ShortSignature
      Control0..*
      TypeSignature