Kenya Patient Summary FHIR IG
0.1.0 - ci-build
Kenya Patient Summary FHIR IG - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2025-12-09 |
Definitions for the ClientRegistrationModel logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. ClientRegistrationModel | |
| Definition | Logical model for registering a client under the Kenya Patient Summary (KPS.A) standard. |
| Short | KPS.A Client Registration |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. ClientRegistrationModel.identifier | |
| Definition | Government-issued identifier used to distinguish individuals, e.g., National ID (adults) or Birth Certificate number (under 18) |
| Short | Government-issued identifier used to distinguish individuals, e.g., National ID (adults) or Birth Certificate number (under 18) |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..1 |
| Type | Identifier |
| Definitional Codes | [not stated]: KPS.A.DE.1 (KPS.A.DE.1) |
| 4. ClientRegistrationModel.name | |
| Definition | Client's name |
| Short | Client's name |
| Control | 1..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. ClientRegistrationModel.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. ClientRegistrationModel.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 ClientRegistrationModel.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 10. ClientRegistrationModel.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. ClientRegistrationModel.name.given | |
| Definition | Client's first name |
| Short | Client's first name |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.2 (KPS.A.DE.2) |
| 14. ClientRegistrationModel.name.family | |
| Definition | Client's family name or last name |
| Short | Client's family name or last name |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.3 (KPS.A.DE.3) |
| 16. ClientRegistrationModel.dateOfBirth | |
| Definition | Client's date of birth, if known |
| Short | Client's date of birth, if known |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.4 (KPS.A.DE.4) |
| 18. ClientRegistrationModel.sex | |
| Definition | Sex of the client assigned at birth |
| Short | Sex of the client assigned at birth |
| Control | 1..1 |
| Binding | The codes SHALL be taken from KPS - Administrative Gender (required to http://example.com/fhir/ValueSet/kps-patient-gender-vs) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.5 (KPS.A.DE.5) |
| 20. ClientRegistrationModel.address | |
| Definition | Client's residential address |
| Short | Client's residential address |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 22. ClientRegistrationModel.address.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 24. ClientRegistrationModel.address.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on ClientRegistrationModel.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 26. ClientRegistrationModel.address.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()) |
| 28. ClientRegistrationModel.address.country | |
| Definition | Name of country of affiliation |
| Short | Name of country of affiliation |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.8 (KPS.A.DE.8) |
| 30. ClientRegistrationModel.address.county | |
| Definition | County where the client resides |
| Short | County where the client resides |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.9 (KPS.A.DE.9) |
| 32. ClientRegistrationModel.address.subcounty | |
| Definition | Subcounty of residence |
| Short | Subcounty of residence |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.10 (KPS.A.DE.10) |
| 34. ClientRegistrationModel.address.ward | |
| Definition | Ward where the client lives |
| Short | Ward where the client lives |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.11 (KPS.A.DE.11) |
| 36. ClientRegistrationModel.address.village | |
| Definition | Village or estate of residence |
| Short | Village or estate of residence |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.12 (KPS.A.DE.12) |
| 38. ClientRegistrationModel.address.postalAddress | |
| Definition | Mailing address including P.O. Box, street or building details |
| Short | Mailing address including P.O. Box, street or building details |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.13 (KPS.A.DE.13) |
| 40. ClientRegistrationModel.telecom | |
| Definition | Client's contact information |
| Short | Client's contact information |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 42. ClientRegistrationModel.telecom.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 |
| 44. ClientRegistrationModel.telecom.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 ClientRegistrationModel.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 46. ClientRegistrationModel.telecom.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()) |
| 48. ClientRegistrationModel.telecom.phone | |
| Definition | Phone number (mobile or landline) |
| Short | Phone number (mobile or landline) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.14 (KPS.A.DE.14) |
| 50. ClientRegistrationModel.telecom.email | |
| Definition | Email address |
| Short | Email address |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.15 (KPS.A.DE.15) |
| 52. ClientRegistrationModel.contactPerson | |
| Definition | Contact person or legal guardian |
| Short | Contact person or legal guardian |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 54. ClientRegistrationModel.contactPerson.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 |
| 56. ClientRegistrationModel.contactPerson.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 ClientRegistrationModel.contactPerson.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 58. ClientRegistrationModel.contactPerson.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()) |
| 60. ClientRegistrationModel.contactPerson.role | |
| Definition | Role: legal guardian, next of kin, or other |
| Short | Role: legal guardian, next of kin, or other |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Patient Contact Relationship ValueSet (required to https://example.org/fhir/ValueSet/patient-contact-relationship-vs) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.16 (KPS.A.DE.16) |
| 62. ClientRegistrationModel.contactPerson.relationship | |
| Definition | Relationship to the client (e.g., father, spouse, daughter) |
| Short | Relationship to the client (e.g., father, spouse, daughter) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.20 (KPS.A.DE.20) |
| 64. ClientRegistrationModel.contactPerson.name | |
| Definition | Name of contact person |
| Short | Name of contact person |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 66. ClientRegistrationModel.contactPerson.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 |
| 68. ClientRegistrationModel.contactPerson.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 ClientRegistrationModel.contactPerson.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 70. ClientRegistrationModel.contactPerson.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()) |
| 72. ClientRegistrationModel.contactPerson.name.given | |
| Definition | First name of contact person |
| Short | First name of contact person |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.21 (KPS.A.DE.21) |
| 74. ClientRegistrationModel.contactPerson.name.family | |
| Definition | Surname of contact person |
| Short | Surname of contact person |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.22 (KPS.A.DE.22) |
| 76. ClientRegistrationModel.contactPerson.phone | |
| Definition | Phone number of contact person |
| Short | Phone number of contact person |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.23 (KPS.A.DE.23) |
| 78. ClientRegistrationModel.contactPerson.email | |
| Definition | Email of contact person |
| Short | Email of contact person |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.24 (KPS.A.DE.24) |
| 80. ClientRegistrationModel.insurance | |
| Definition | Insurance information |
| Short | Insurance information |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 82. ClientRegistrationModel.insurance.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 |
| 84. ClientRegistrationModel.insurance.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 ClientRegistrationModel.insurance.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 86. ClientRegistrationModel.insurance.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()) |
| 88. ClientRegistrationModel.insurance.insuranceNumber | |
| Definition | Health insurance ID assigned to the client |
| Short | Health insurance ID assigned to the client |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.26 (KPS.A.DE.26) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ClientRegistrationModel | |
| Definition | Logical model for registering a client under the Kenya Patient Summary (KPS.A) standard. |
| Short | KPS.A Client Registration |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. ClientRegistrationModel.identifier | |
| Definition | Government-issued identifier used to distinguish individuals, e.g., National ID (adults) or Birth Certificate number (under 18) |
| Short | Government-issued identifier used to distinguish individuals, e.g., National ID (adults) or Birth Certificate number (under 18) |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..1 |
| Type | Identifier |
| Definitional Codes | [not stated]: KPS.A.DE.1 (KPS.A.DE.1) |
| 4. ClientRegistrationModel.name | |
| Definition | Client's name |
| Short | Client's name |
| Control | 1..1 |
| Type | BackboneElement |
| 6. ClientRegistrationModel.name.given | |
| Definition | Client's first name |
| Short | Client's first name |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.2 (KPS.A.DE.2) |
| 8. ClientRegistrationModel.name.family | |
| Definition | Client's family name or last name |
| Short | Client's family name or last name |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.3 (KPS.A.DE.3) |
| 10. ClientRegistrationModel.dateOfBirth | |
| Definition | Client's date of birth, if known |
| Short | Client's date of birth, if known |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.4 (KPS.A.DE.4) |
| 12. ClientRegistrationModel.sex | |
| Definition | Sex of the client assigned at birth |
| Short | Sex of the client assigned at birth |
| Control | 1..1 |
| Binding | The codes SHALL be taken from KPS - Administrative Gender (required to http://example.com/fhir/ValueSet/kps-patient-gender-vs) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.5 (KPS.A.DE.5) |
| 14. ClientRegistrationModel.address | |
| Definition | Client's residential address |
| Short | Client's residential address |
| Control | 0..1 |
| Type | BackboneElement |
| 16. ClientRegistrationModel.address.country | |
| Definition | Name of country of affiliation |
| Short | Name of country of affiliation |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.8 (KPS.A.DE.8) |
| 18. ClientRegistrationModel.address.county | |
| Definition | County where the client resides |
| Short | County where the client resides |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.9 (KPS.A.DE.9) |
| 20. ClientRegistrationModel.address.subcounty | |
| Definition | Subcounty of residence |
| Short | Subcounty of residence |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.10 (KPS.A.DE.10) |
| 22. ClientRegistrationModel.address.ward | |
| Definition | Ward where the client lives |
| Short | Ward where the client lives |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.11 (KPS.A.DE.11) |
| 24. ClientRegistrationModel.address.village | |
| Definition | Village or estate of residence |
| Short | Village or estate of residence |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.12 (KPS.A.DE.12) |
| 26. ClientRegistrationModel.address.postalAddress | |
| Definition | Mailing address including P.O. Box, street or building details |
| Short | Mailing address including P.O. Box, street or building details |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.13 (KPS.A.DE.13) |
| 28. ClientRegistrationModel.telecom | |
| Definition | Client's contact information |
| Short | Client's contact information |
| Control | 0..1 |
| Type | BackboneElement |
| 30. ClientRegistrationModel.telecom.phone | |
| Definition | Phone number (mobile or landline) |
| Short | Phone number (mobile or landline) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.14 (KPS.A.DE.14) |
| 32. ClientRegistrationModel.telecom.email | |
| Definition | Email address |
| Short | Email address |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.15 (KPS.A.DE.15) |
| 34. ClientRegistrationModel.contactPerson | |
| Definition | Contact person or legal guardian |
| Short | Contact person or legal guardian |
| Control | 0..1 |
| Type | BackboneElement |
| 36. ClientRegistrationModel.contactPerson.role | |
| Definition | Role: legal guardian, next of kin, or other |
| Short | Role: legal guardian, next of kin, or other |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Patient Contact Relationship ValueSet (required to https://example.org/fhir/ValueSet/patient-contact-relationship-vs) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.16 (KPS.A.DE.16) |
| 38. ClientRegistrationModel.contactPerson.relationship | |
| Definition | Relationship to the client (e.g., father, spouse, daughter) |
| Short | Relationship to the client (e.g., father, spouse, daughter) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.20 (KPS.A.DE.20) |
| 40. ClientRegistrationModel.contactPerson.name | |
| Definition | Name of contact person |
| Short | Name of contact person |
| Control | 0..1 |
| Type | BackboneElement |
| 42. ClientRegistrationModel.contactPerson.name.given | |
| Definition | First name of contact person |
| Short | First name of contact person |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.21 (KPS.A.DE.21) |
| 44. ClientRegistrationModel.contactPerson.name.family | |
| Definition | Surname of contact person |
| Short | Surname of contact person |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.22 (KPS.A.DE.22) |
| 46. ClientRegistrationModel.contactPerson.phone | |
| Definition | Phone number of contact person |
| Short | Phone number of contact person |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.23 (KPS.A.DE.23) |
| 48. ClientRegistrationModel.contactPerson.email | |
| Definition | Email of contact person |
| Short | Email of contact person |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.24 (KPS.A.DE.24) |
| 50. ClientRegistrationModel.insurance | |
| Definition | Insurance information |
| Short | Insurance information |
| Control | 0..1 |
| Type | BackboneElement |
| 52. ClientRegistrationModel.insurance.insuranceNumber | |
| Definition | Health insurance ID assigned to the client |
| Short | Health insurance ID assigned to the client |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.26 (KPS.A.DE.26) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ClientRegistrationModel | |
| Definition | Logical model for registering a client under the Kenya Patient Summary (KPS.A) standard. |
| Short | KPS.A Client Registration |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. ClientRegistrationModel.identifier | |
| Definition | Government-issued identifier used to distinguish individuals, e.g., National ID (adults) or Birth Certificate number (under 18) |
| Short | Government-issued identifier used to distinguish individuals, e.g., National ID (adults) or Birth Certificate number (under 18) |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..1 |
| Type | Identifier |
| Definitional Codes | [not stated]: KPS.A.DE.1 (KPS.A.DE.1) |
| 4. ClientRegistrationModel.name | |
| Definition | Client's name |
| Short | Client's name |
| Control | 1..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. ClientRegistrationModel.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. ClientRegistrationModel.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 ClientRegistrationModel.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 10. ClientRegistrationModel.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. ClientRegistrationModel.name.given | |
| Definition | Client's first name |
| Short | Client's first name |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.2 (KPS.A.DE.2) |
| 14. ClientRegistrationModel.name.family | |
| Definition | Client's family name or last name |
| Short | Client's family name or last name |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.3 (KPS.A.DE.3) |
| 16. ClientRegistrationModel.dateOfBirth | |
| Definition | Client's date of birth, if known |
| Short | Client's date of birth, if known |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.4 (KPS.A.DE.4) |
| 18. ClientRegistrationModel.sex | |
| Definition | Sex of the client assigned at birth |
| Short | Sex of the client assigned at birth |
| Control | 1..1 |
| Binding | The codes SHALL be taken from KPS - Administrative Gender (required to http://example.com/fhir/ValueSet/kps-patient-gender-vs) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.5 (KPS.A.DE.5) |
| 20. ClientRegistrationModel.address | |
| Definition | Client's residential address |
| Short | Client's residential address |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 22. ClientRegistrationModel.address.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 24. ClientRegistrationModel.address.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on ClientRegistrationModel.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 26. ClientRegistrationModel.address.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()) |
| 28. ClientRegistrationModel.address.country | |
| Definition | Name of country of affiliation |
| Short | Name of country of affiliation |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.8 (KPS.A.DE.8) |
| 30. ClientRegistrationModel.address.county | |
| Definition | County where the client resides |
| Short | County where the client resides |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.9 (KPS.A.DE.9) |
| 32. ClientRegistrationModel.address.subcounty | |
| Definition | Subcounty of residence |
| Short | Subcounty of residence |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.10 (KPS.A.DE.10) |
| 34. ClientRegistrationModel.address.ward | |
| Definition | Ward where the client lives |
| Short | Ward where the client lives |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.11 (KPS.A.DE.11) |
| 36. ClientRegistrationModel.address.village | |
| Definition | Village or estate of residence |
| Short | Village or estate of residence |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.12 (KPS.A.DE.12) |
| 38. ClientRegistrationModel.address.postalAddress | |
| Definition | Mailing address including P.O. Box, street or building details |
| Short | Mailing address including P.O. Box, street or building details |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.13 (KPS.A.DE.13) |
| 40. ClientRegistrationModel.telecom | |
| Definition | Client's contact information |
| Short | Client's contact information |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 42. ClientRegistrationModel.telecom.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 |
| 44. ClientRegistrationModel.telecom.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 ClientRegistrationModel.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 46. ClientRegistrationModel.telecom.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()) |
| 48. ClientRegistrationModel.telecom.phone | |
| Definition | Phone number (mobile or landline) |
| Short | Phone number (mobile or landline) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.14 (KPS.A.DE.14) |
| 50. ClientRegistrationModel.telecom.email | |
| Definition | Email address |
| Short | Email address |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.15 (KPS.A.DE.15) |
| 52. ClientRegistrationModel.contactPerson | |
| Definition | Contact person or legal guardian |
| Short | Contact person or legal guardian |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 54. ClientRegistrationModel.contactPerson.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 |
| 56. ClientRegistrationModel.contactPerson.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 ClientRegistrationModel.contactPerson.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 58. ClientRegistrationModel.contactPerson.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()) |
| 60. ClientRegistrationModel.contactPerson.role | |
| Definition | Role: legal guardian, next of kin, or other |
| Short | Role: legal guardian, next of kin, or other |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Patient Contact Relationship ValueSet (required to https://example.org/fhir/ValueSet/patient-contact-relationship-vs) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.16 (KPS.A.DE.16) |
| 62. ClientRegistrationModel.contactPerson.relationship | |
| Definition | Relationship to the client (e.g., father, spouse, daughter) |
| Short | Relationship to the client (e.g., father, spouse, daughter) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.20 (KPS.A.DE.20) |
| 64. ClientRegistrationModel.contactPerson.name | |
| Definition | Name of contact person |
| Short | Name of contact person |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 66. ClientRegistrationModel.contactPerson.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 |
| 68. ClientRegistrationModel.contactPerson.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 ClientRegistrationModel.contactPerson.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 70. ClientRegistrationModel.contactPerson.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()) |
| 72. ClientRegistrationModel.contactPerson.name.given | |
| Definition | First name of contact person |
| Short | First name of contact person |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.21 (KPS.A.DE.21) |
| 74. ClientRegistrationModel.contactPerson.name.family | |
| Definition | Surname of contact person |
| Short | Surname of contact person |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.22 (KPS.A.DE.22) |
| 76. ClientRegistrationModel.contactPerson.phone | |
| Definition | Phone number of contact person |
| Short | Phone number of contact person |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.23 (KPS.A.DE.23) |
| 78. ClientRegistrationModel.contactPerson.email | |
| Definition | Email of contact person |
| Short | Email of contact person |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.24 (KPS.A.DE.24) |
| 80. ClientRegistrationModel.insurance | |
| Definition | Insurance information |
| Short | Insurance information |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 82. ClientRegistrationModel.insurance.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 |
| 84. ClientRegistrationModel.insurance.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 ClientRegistrationModel.insurance.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 86. ClientRegistrationModel.insurance.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()) |
| 88. ClientRegistrationModel.insurance.insuranceNumber | |
| Definition | Health insurance ID assigned to the client |
| Short | Health insurance ID assigned to the client |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated]: KPS.A.DE.26 (KPS.A.DE.26) |