0.1.0 - ci-build
            
          
KISUMUHIEFHIRIG, published by intellisoftkenya. 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/IntelliSOFT-Consulting/Kisumu-County-HIE-FHIR-IG/ and changes regularly. See the Directory of published versions
| Official URL: http://fhir.kisumuhealth.co.ke/StructureDefinition/ksm-patient | Version: 0.1.0 | |||
| Draft as of 2025-09-02 | Computable Name: KsmPatient | |||
Demographics for the Kisumu County Patient
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   Patient | C | 0..* | Patient | Information about an individual or animal receiving health care services Constraints: PatientIdentification-1, MustHavePhoneNumber-1 | 
|    implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | 
|    modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | 
|    Slices for identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system | 
|     identifier:NationalIDNo | SΣ | 0..1 | Identifier | An identifier for this patient | 
|      use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | 
|      system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/nationalID-no | 
|      value | Σ | 1..1 | string | The value that is unique Example General: 123456 | 
|     identifier:NUPI | SΣ | 0..1 | Identifier | An identifier for this patient | 
|      use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | 
|      system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/NUPI | 
|      value | Σ | 1..1 | string | The value that is unique Example General: 123456 | 
|     identifier:PassportNo | SΣ | 0..1 | Identifier | An identifier for this patient | 
|      use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | 
|      system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/passport-No | 
|      value | Σ | 1..1 | string | The value that is unique Example General: 123456 | 
|     identifier:BirthCertificateNo | SΣ | 0..1 | Identifier | An identifier for this patient | 
|      use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | 
|      system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/birthCertificate-No | 
|      value | Σ | 1..1 | string | The value that is unique Example General: 123456 | 
|     identifier:BirthNotificationNo | SΣ | 0..1 | Identifier | An identifier for this patient | 
|      use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | 
|      system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/birthNotification-No | 
|      value | Σ | 1..1 | string | The value that is unique Example General: 123456 | 
|     identifier:WonderId | SΣ | 0..1 | Identifier | An identifier for this patient | 
|      use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | 
|      system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/WONDER4HEALTH-ID | 
|      value | Σ | 1..1 | string | The value that is unique Example General: 123456 | 
|    active | ?!SΣ | 0..1 | boolean | Whether this patient's record is in active use | 
|    name | Σ | 0..* | HumanName | A name associated with the patient | 
|     use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | 
|     family | SΣ | 1..1 | string | Patient's surname | 
|     given | SΣ | 1..* | string | Other patient names i.e first and middle name This repeating element order: Given Names appear in the correct order for presenting the name | 
|    telecom | SΣ | 0..* | ContactPoint | A contact detail for the individual | 
|     system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | 
|     value | SΣ | 1..1 | string | The actual contact point details | 
|     use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | 
|    gender | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | 
|    birthDate | SΣ | 0..1 | date | The date of birth for the individual | 
|    deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
|     deceasedBoolean | boolean | |||
|     deceasedDateTime | dateTime | |||
|    address | Σ | 0..* | Address | An address for the individual | 
|     use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | 
|     text | SΣ | 0..1 | string | Patient's Address Example General: 137 Nowhere Street, Erewhon 9132 | 
|     line | SΣ | 0..2 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | 
|     city | SΣ | 0..1 | string | Patient's Sub-County Example General: Erewhon | 
|     district | SΣ | 0..1 | string | Patient's Ward  of residence Example General: Madison | 
|     state | SΣ | 0..1 | string | Patient's County of residence | 
|     postalCode | SΣ | 0..1 | string | Patient's postal code Example General: 9132 | 
|     country | SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | 
|    maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |
|     coding | Σ | 0..* | Coding | Code defined by a terminology system | 
|      system | SΣ | 1..1 | uri | Identity of the terminology system | 
|      code | SΣ | 1..1 | code | Symbol in syntax defined by the system | 
|    managingOrganization | SΣ | 1..1 | Reference(Service Provider - Facility) | Organization that is the custodian of the patient record | 
|    link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | 
|     modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
|     other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | 
|     type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | 
|  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| Patient.identifier:NationalIDNo.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Patient.identifier:NUPI.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Patient.identifier:PassportNo.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Patient.identifier:BirthCertificateNo.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Patient.identifier:BirthNotificationNo.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Patient.identifier:WonderId.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Patient.name.use | required | NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1From the FHIR Standard | |
| Patient.telecom.system | required | ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1From the FHIR Standard | |
| Patient.telecom.use | required | ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1From the FHIR Standard | |
| Patient.gender | required | AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1From the FHIR Standard | |
| Patient.address.use | required | AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1From the FHIR Standard | |
| Patient.maritalStatus | extensible | Marital Status Codes http://hl7.org/fhir/ValueSet/marital-statusFrom the FHIR Standard | |
| Patient.link.type | required | LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1From the FHIR Standard | 
| Id | Grade | Path(s) | Details | Requirements | 
| MustHavePhoneNumber-1 | error | Patient | At least one telecom entry must have system = 'phone' and a value. : telecom.where(system = 'phone' and value.exists()).exists() | |
| PatientIdentification-1 | error | Patient | The Patient profile SHALL have at least one identifier "NationaID" or "BirthCertificate". : identifier.slice('http://example.org/StructureDefinition/ksm-patient','NationalIDNo').count() + identifier.slice('http://example.org/StructureDefinition/ksm-patient','BirthCertificateNo').count() > 0 | |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | 
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   Patient | C | 0..* | Patient | Information about an individual or animal receiving health care services Constraints: PatientIdentification-1, MustHavePhoneNumber-1 | 
|    Slices for identifier | S | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system | 
|     identifier:NationalIDNo | S | 0..1 | Identifier | An identifier for this patient | 
|      system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/nationalID-no | |
|      value | 1..1 | string | The value that is unique | |
|     identifier:NUPI | S | 0..1 | Identifier | An identifier for this patient | 
|      system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/NUPI | |
|      value | 1..1 | string | The value that is unique | |
|     identifier:PassportNo | S | 0..1 | Identifier | An identifier for this patient | 
|      system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/passport-No | |
|      value | 1..1 | string | The value that is unique | |
|     identifier:BirthCertificateNo | S | 0..1 | Identifier | An identifier for this patient | 
|      system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/birthCertificate-No | |
|      value | 1..1 | string | The value that is unique | |
|     identifier:BirthNotificationNo | S | 0..1 | Identifier | An identifier for this patient | 
|      system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/birthNotification-No | |
|      value | 1..1 | string | The value that is unique | |
|     identifier:WonderId | S | 0..1 | Identifier | An identifier for this patient | 
|      system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/WONDER4HEALTH-ID | |
|      value | 1..1 | string | The value that is unique | |
|    active | S | 0..1 | boolean | Whether this patient's record is in active use | 
|    name | ||||
|     family | S | 1..1 | string | Patient's surname | 
|     given | S | 1..* | string | Other patient names i.e first and middle name | 
|    telecom | S | 0..* | ContactPoint | A contact detail for the individual | 
|     system | S | 1..1 | code | phone | fax | email | pager | url | sms | other | 
|     value | S | 1..1 | string | The actual contact point details | 
|    gender | S | 1..1 | code | male | female | other | unknown | 
|    birthDate | S | 0..1 | date | The date of birth for the individual | 
|    address | ||||
|     text | S | 0..1 | string | Patient's Address | 
|     line | S | 0..2 | string | Street name, number, direction & P.O. Box etc. | 
|     city | S | 0..1 | string | Patient's Sub-County | 
|     district | S | 0..1 | string | Patient's Ward of residence | 
|     state | S | 0..1 | string | Patient's County of residence | 
|     postalCode | S | 0..1 | string | Patient's postal code | 
|     country | S | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | 
|    maritalStatus | ||||
|     coding | ||||
|      system | S | 1..1 | uri | Identity of the terminology system | 
|      code | S | 1..1 | code | Symbol in syntax defined by the system | 
|    managingOrganization | S | 1..1 | Reference(Service Provider - Facility) | Organization that is the custodian of the patient record | 
|  Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements | 
| MustHavePhoneNumber-1 | error | Patient | At least one telecom entry must have system = 'phone' and a value. : telecom.where(system = 'phone' and value.exists()).exists() | |
| PatientIdentification-1 | error | Patient | The Patient profile SHALL have at least one identifier "NationaID" or "BirthCertificate". : identifier.slice('http://example.org/StructureDefinition/ksm-patient','NationalIDNo').count() + identifier.slice('http://example.org/StructureDefinition/ksm-patient','BirthCertificateNo').count() > 0 | 
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | ||||
|---|---|---|---|---|---|---|---|---|
|   Patient | C | 0..* | Patient | Information about an individual or animal receiving health care services Constraints: PatientIdentification-1, MustHavePhoneNumber-1 | ||||
|    id | Σ | 0..1 | id | Logical id of this artifact | ||||
|    meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
|    implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|    language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
 | |||||
|    text | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
|    contained | 0..* | Resource | Contained, inline Resources | |||||
|    extension | 0..* | Extension | Additional content defined by implementations | |||||
|    modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
|    Slices for identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system | ||||
|     identifier:NationalIDNo | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|      use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
|      type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
|      system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/nationalID-no | ||||
|      value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
|      period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
|      assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
|     identifier:NUPI | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|      use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
|      type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
|      system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/NUPI | ||||
|      value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
|      period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
|      assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
|     identifier:PassportNo | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|      use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
|      type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
|      system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/passport-No | ||||
|      value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
|      period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
|      assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
|     identifier:BirthCertificateNo | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|      use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
|      type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
|      system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/birthCertificate-No | ||||
|      value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
|      period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
|      assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
|     identifier:BirthNotificationNo | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|      use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
|      type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
|      system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/birthNotification-No | ||||
|      value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
|      period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
|      assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
|     identifier:WonderId | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|      use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
|      type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
|      system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/WONDER4HEALTH-ID | ||||
|      value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
|      period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
|      assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
|    active | ?!SΣ | 0..1 | boolean | Whether this patient's record is in active use | ||||
|    name | Σ | 0..* | HumanName | A name associated with the patient | ||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|     use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
|     text | Σ | 0..1 | string | Text representation of the full name | ||||
|     family | SΣ | 1..1 | string | Patient's surname | ||||
|     given | SΣ | 1..* | string | Other patient names i.e first and middle name This repeating element order: Given Names appear in the correct order for presenting the name | ||||
|     prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
|     suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
|     period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
|    telecom | SΣ | 0..* | ContactPoint | A contact detail for the individual | ||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|     system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
|     value | SΣ | 1..1 | string | The actual contact point details | ||||
|     use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
|     rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
|     period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
|    gender | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
|    birthDate | SΣ | 0..1 | date | The date of birth for the individual | ||||
|    deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
|     deceasedBoolean | boolean | |||||||
|     deceasedDateTime | dateTime | |||||||
|    address | Σ | 0..* | Address | An address for the individual | ||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|     use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
|     type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
|     text | SΣ | 0..1 | string | Patient's Address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
|     line | SΣ | 0..2 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
|     city | SΣ | 0..1 | string | Patient's Sub-County Example General: Erewhon | ||||
|     district | SΣ | 0..1 | string | Patient's Ward  of residence Example General: Madison | ||||
|     state | SΣ | 0..1 | string | Patient's County of residence | ||||
|     postalCode | SΣ | 0..1 | string | Patient's postal code Example General: 9132 | ||||
|     country | SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
|     period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
|    maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|     coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|      system | SΣ | 1..1 | uri | Identity of the terminology system | ||||
|      version | Σ | 0..1 | string | Version of the system - if relevant | ||||
|      code | SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
|      display | Σ | 0..1 | string | Representation defined by the system | ||||
|      userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
|     text | Σ | 0..1 | string | Plain text representation of the concept | ||||
|    multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
|     multipleBirthBoolean | boolean | |||||||
|     multipleBirthInteger | integer | |||||||
|    photo | 0..* | Attachment | Image of the patient | |||||
|    contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1 | ||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations | |||||
|     modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
|     relationship | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
|     name | 0..1 | HumanName | A name associated with the contact person | |||||
|     telecom | 0..* | ContactPoint | A contact detail for the person | |||||
|     address | 0..1 | Address | Address for the contact person | |||||
|     gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
|     organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
|     period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
|    communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations | |||||
|     modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
|     language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. 
 | |||||
|     preferred | 0..1 | boolean | Language preference indicator | |||||
|    generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
|    managingOrganization | SΣ | 1..1 | Reference(Service Provider - Facility) | Organization that is the custodian of the patient record | ||||
|    link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations | |||||
|     modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
|     other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
|     type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
|  Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Patient.language | preferred | CommonLanguages http://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard 
 | ||||
| Patient.identifier:NationalIDNo.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Patient.identifier:NationalIDNo.type | extensible | Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Patient.identifier:NUPI.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Patient.identifier:NUPI.type | extensible | Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Patient.identifier:PassportNo.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Patient.identifier:PassportNo.type | extensible | Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Patient.identifier:BirthCertificateNo.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Patient.identifier:BirthCertificateNo.type | extensible | Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Patient.identifier:BirthNotificationNo.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Patient.identifier:BirthNotificationNo.type | extensible | Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Patient.identifier:WonderId.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Patient.identifier:WonderId.type | extensible | Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Patient.name.use | required | NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1From the FHIR Standard | ||||
| Patient.telecom.system | required | ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1From the FHIR Standard | ||||
| Patient.telecom.use | required | ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1From the FHIR Standard | ||||
| Patient.gender | required | AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1From the FHIR Standard | ||||
| Patient.address.use | required | AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1From the FHIR Standard | ||||
| Patient.address.type | required | AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1From the FHIR Standard | ||||
| Patient.maritalStatus | extensible | Marital Status Codes http://hl7.org/fhir/ValueSet/marital-statusFrom the FHIR Standard | ||||
| Patient.contact.relationship | extensible | PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationshipFrom the FHIR Standard | ||||
| Patient.contact.gender | required | AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1From the FHIR Standard | ||||
| Patient.communication.language | preferred | CommonLanguages http://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard 
 | ||||
| Patient.link.type | required | LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1From the FHIR Standard | 
| Id | Grade | Path(s) | Details | Requirements | 
| MustHavePhoneNumber-1 | error | Patient | At least one telecom entry must have system = 'phone' and a value. : telecom.where(system = 'phone' and value.exists()).exists() | |
| PatientIdentification-1 | error | Patient | The Patient profile SHALL have at least one identifier "NationaID" or "BirthCertificate". : identifier.slice('http://example.org/StructureDefinition/ksm-patient','NationalIDNo').count() + identifier.slice('http://example.org/StructureDefinition/ksm-patient','BirthCertificateNo').count() > 0 | |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() | 
This structure is derived from Patient
Summary
Mandatory: 3 elements(18 nested mandatory elements)
 Must-Support: 25 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   Patient | C | 0..* | Patient | Information about an individual or animal receiving health care services Constraints: PatientIdentification-1, MustHavePhoneNumber-1 | 
|    implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | 
|    modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | 
|    Slices for identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system | 
|     identifier:NationalIDNo | SΣ | 0..1 | Identifier | An identifier for this patient | 
|      use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | 
|      system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/nationalID-no | 
|      value | Σ | 1..1 | string | The value that is unique Example General: 123456 | 
|     identifier:NUPI | SΣ | 0..1 | Identifier | An identifier for this patient | 
|      use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | 
|      system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/NUPI | 
|      value | Σ | 1..1 | string | The value that is unique Example General: 123456 | 
|     identifier:PassportNo | SΣ | 0..1 | Identifier | An identifier for this patient | 
|      use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | 
|      system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/passport-No | 
|      value | Σ | 1..1 | string | The value that is unique Example General: 123456 | 
|     identifier:BirthCertificateNo | SΣ | 0..1 | Identifier | An identifier for this patient | 
|      use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | 
|      system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/birthCertificate-No | 
|      value | Σ | 1..1 | string | The value that is unique Example General: 123456 | 
|     identifier:BirthNotificationNo | SΣ | 0..1 | Identifier | An identifier for this patient | 
|      use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | 
|      system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/birthNotification-No | 
|      value | Σ | 1..1 | string | The value that is unique Example General: 123456 | 
|     identifier:WonderId | SΣ | 0..1 | Identifier | An identifier for this patient | 
|      use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | 
|      system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/WONDER4HEALTH-ID | 
|      value | Σ | 1..1 | string | The value that is unique Example General: 123456 | 
|    active | ?!SΣ | 0..1 | boolean | Whether this patient's record is in active use | 
|    name | Σ | 0..* | HumanName | A name associated with the patient | 
|     use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | 
|     family | SΣ | 1..1 | string | Patient's surname | 
|     given | SΣ | 1..* | string | Other patient names i.e first and middle name This repeating element order: Given Names appear in the correct order for presenting the name | 
|    telecom | SΣ | 0..* | ContactPoint | A contact detail for the individual | 
|     system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | 
|     value | SΣ | 1..1 | string | The actual contact point details | 
|     use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | 
|    gender | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | 
|    birthDate | SΣ | 0..1 | date | The date of birth for the individual | 
|    deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
|     deceasedBoolean | boolean | |||
|     deceasedDateTime | dateTime | |||
|    address | Σ | 0..* | Address | An address for the individual | 
|     use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | 
|     text | SΣ | 0..1 | string | Patient's Address Example General: 137 Nowhere Street, Erewhon 9132 | 
|     line | SΣ | 0..2 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | 
|     city | SΣ | 0..1 | string | Patient's Sub-County Example General: Erewhon | 
|     district | SΣ | 0..1 | string | Patient's Ward  of residence Example General: Madison | 
|     state | SΣ | 0..1 | string | Patient's County of residence | 
|     postalCode | SΣ | 0..1 | string | Patient's postal code Example General: 9132 | 
|     country | SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | 
|    maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |
|     coding | Σ | 0..* | Coding | Code defined by a terminology system | 
|      system | SΣ | 1..1 | uri | Identity of the terminology system | 
|      code | SΣ | 1..1 | code | Symbol in syntax defined by the system | 
|    managingOrganization | SΣ | 1..1 | Reference(Service Provider - Facility) | Organization that is the custodian of the patient record | 
|    link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | 
|     modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
|     other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | 
|     type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | 
|  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| Patient.identifier:NationalIDNo.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Patient.identifier:NUPI.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Patient.identifier:PassportNo.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Patient.identifier:BirthCertificateNo.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Patient.identifier:BirthNotificationNo.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Patient.identifier:WonderId.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Patient.name.use | required | NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1From the FHIR Standard | |
| Patient.telecom.system | required | ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1From the FHIR Standard | |
| Patient.telecom.use | required | ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1From the FHIR Standard | |
| Patient.gender | required | AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1From the FHIR Standard | |
| Patient.address.use | required | AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1From the FHIR Standard | |
| Patient.maritalStatus | extensible | Marital Status Codes http://hl7.org/fhir/ValueSet/marital-statusFrom the FHIR Standard | |
| Patient.link.type | required | LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1From the FHIR Standard | 
| Id | Grade | Path(s) | Details | Requirements | 
| MustHavePhoneNumber-1 | error | Patient | At least one telecom entry must have system = 'phone' and a value. : telecom.where(system = 'phone' and value.exists()).exists() | |
| PatientIdentification-1 | error | Patient | The Patient profile SHALL have at least one identifier "NationaID" or "BirthCertificate". : identifier.slice('http://example.org/StructureDefinition/ksm-patient','NationalIDNo').count() + identifier.slice('http://example.org/StructureDefinition/ksm-patient','BirthCertificateNo').count() > 0 | |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | 
Differential View
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   Patient | C | 0..* | Patient | Information about an individual or animal receiving health care services Constraints: PatientIdentification-1, MustHavePhoneNumber-1 | 
|    Slices for identifier | S | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system | 
|     identifier:NationalIDNo | S | 0..1 | Identifier | An identifier for this patient | 
|      system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/nationalID-no | |
|      value | 1..1 | string | The value that is unique | |
|     identifier:NUPI | S | 0..1 | Identifier | An identifier for this patient | 
|      system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/NUPI | |
|      value | 1..1 | string | The value that is unique | |
|     identifier:PassportNo | S | 0..1 | Identifier | An identifier for this patient | 
|      system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/passport-No | |
|      value | 1..1 | string | The value that is unique | |
|     identifier:BirthCertificateNo | S | 0..1 | Identifier | An identifier for this patient | 
|      system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/birthCertificate-No | |
|      value | 1..1 | string | The value that is unique | |
|     identifier:BirthNotificationNo | S | 0..1 | Identifier | An identifier for this patient | 
|      system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/birthNotification-No | |
|      value | 1..1 | string | The value that is unique | |
|     identifier:WonderId | S | 0..1 | Identifier | An identifier for this patient | 
|      system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/WONDER4HEALTH-ID | |
|      value | 1..1 | string | The value that is unique | |
|    active | S | 0..1 | boolean | Whether this patient's record is in active use | 
|    name | ||||
|     family | S | 1..1 | string | Patient's surname | 
|     given | S | 1..* | string | Other patient names i.e first and middle name | 
|    telecom | S | 0..* | ContactPoint | A contact detail for the individual | 
|     system | S | 1..1 | code | phone | fax | email | pager | url | sms | other | 
|     value | S | 1..1 | string | The actual contact point details | 
|    gender | S | 1..1 | code | male | female | other | unknown | 
|    birthDate | S | 0..1 | date | The date of birth for the individual | 
|    address | ||||
|     text | S | 0..1 | string | Patient's Address | 
|     line | S | 0..2 | string | Street name, number, direction & P.O. Box etc. | 
|     city | S | 0..1 | string | Patient's Sub-County | 
|     district | S | 0..1 | string | Patient's Ward of residence | 
|     state | S | 0..1 | string | Patient's County of residence | 
|     postalCode | S | 0..1 | string | Patient's postal code | 
|     country | S | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | 
|    maritalStatus | ||||
|     coding | ||||
|      system | S | 1..1 | uri | Identity of the terminology system | 
|      code | S | 1..1 | code | Symbol in syntax defined by the system | 
|    managingOrganization | S | 1..1 | Reference(Service Provider - Facility) | Organization that is the custodian of the patient record | 
|  Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements | 
| MustHavePhoneNumber-1 | error | Patient | At least one telecom entry must have system = 'phone' and a value. : telecom.where(system = 'phone' and value.exists()).exists() | |
| PatientIdentification-1 | error | Patient | The Patient profile SHALL have at least one identifier "NationaID" or "BirthCertificate". : identifier.slice('http://example.org/StructureDefinition/ksm-patient','NationalIDNo').count() + identifier.slice('http://example.org/StructureDefinition/ksm-patient','BirthCertificateNo').count() > 0 | 
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | ||||
|---|---|---|---|---|---|---|---|---|
|   Patient | C | 0..* | Patient | Information about an individual or animal receiving health care services Constraints: PatientIdentification-1, MustHavePhoneNumber-1 | ||||
|    id | Σ | 0..1 | id | Logical id of this artifact | ||||
|    meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
|    implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|    language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
 | |||||
|    text | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
|    contained | 0..* | Resource | Contained, inline Resources | |||||
|    extension | 0..* | Extension | Additional content defined by implementations | |||||
|    modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
|    Slices for identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system | ||||
|     identifier:NationalIDNo | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|      use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
|      type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
|      system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/nationalID-no | ||||
|      value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
|      period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
|      assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
|     identifier:NUPI | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|      use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
|      type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
|      system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/NUPI | ||||
|      value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
|      period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
|      assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
|     identifier:PassportNo | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|      use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
|      type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
|      system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/passport-No | ||||
|      value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
|      period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
|      assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
|     identifier:BirthCertificateNo | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|      use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
|      type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
|      system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/birthCertificate-No | ||||
|      value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
|      period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
|      assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
|     identifier:BirthNotificationNo | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|      use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
|      type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
|      system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/birthNotification-No | ||||
|      value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
|      period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
|      assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
|     identifier:WonderId | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|      use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
|      type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
|      system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.kenya/identifier/WONDER4HEALTH-ID | ||||
|      value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
|      period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
|      assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
|    active | ?!SΣ | 0..1 | boolean | Whether this patient's record is in active use | ||||
|    name | Σ | 0..* | HumanName | A name associated with the patient | ||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|     use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
|     text | Σ | 0..1 | string | Text representation of the full name | ||||
|     family | SΣ | 1..1 | string | Patient's surname | ||||
|     given | SΣ | 1..* | string | Other patient names i.e first and middle name This repeating element order: Given Names appear in the correct order for presenting the name | ||||
|     prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
|     suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
|     period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
|    telecom | SΣ | 0..* | ContactPoint | A contact detail for the individual | ||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|     system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
|     value | SΣ | 1..1 | string | The actual contact point details | ||||
|     use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
|     rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
|     period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
|    gender | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
|    birthDate | SΣ | 0..1 | date | The date of birth for the individual | ||||
|    deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
|     deceasedBoolean | boolean | |||||||
|     deceasedDateTime | dateTime | |||||||
|    address | Σ | 0..* | Address | An address for the individual | ||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|     use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
|     type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
|     text | SΣ | 0..1 | string | Patient's Address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
|     line | SΣ | 0..2 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
|     city | SΣ | 0..1 | string | Patient's Sub-County Example General: Erewhon | ||||
|     district | SΣ | 0..1 | string | Patient's Ward  of residence Example General: Madison | ||||
|     state | SΣ | 0..1 | string | Patient's County of residence | ||||
|     postalCode | SΣ | 0..1 | string | Patient's postal code Example General: 9132 | ||||
|     country | SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
|     period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
|    maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|     coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|      system | SΣ | 1..1 | uri | Identity of the terminology system | ||||
|      version | Σ | 0..1 | string | Version of the system - if relevant | ||||
|      code | SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
|      display | Σ | 0..1 | string | Representation defined by the system | ||||
|      userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
|     text | Σ | 0..1 | string | Plain text representation of the concept | ||||
|    multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
|     multipleBirthBoolean | boolean | |||||||
|     multipleBirthInteger | integer | |||||||
|    photo | 0..* | Attachment | Image of the patient | |||||
|    contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1 | ||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations | |||||
|     modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
|     relationship | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
|     name | 0..1 | HumanName | A name associated with the contact person | |||||
|     telecom | 0..* | ContactPoint | A contact detail for the person | |||||
|     address | 0..1 | Address | Address for the contact person | |||||
|     gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
|     organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
|     period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
|    communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations | |||||
|     modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
|     language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. 
 | |||||
|     preferred | 0..1 | boolean | Language preference indicator | |||||
|    generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
|    managingOrganization | SΣ | 1..1 | Reference(Service Provider - Facility) | Organization that is the custodian of the patient record | ||||
|    link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations | |||||
|     modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
|     other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
|     type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
|  Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Patient.language | preferred | CommonLanguages http://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard 
 | ||||
| Patient.identifier:NationalIDNo.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Patient.identifier:NationalIDNo.type | extensible | Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Patient.identifier:NUPI.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Patient.identifier:NUPI.type | extensible | Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Patient.identifier:PassportNo.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Patient.identifier:PassportNo.type | extensible | Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Patient.identifier:BirthCertificateNo.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Patient.identifier:BirthCertificateNo.type | extensible | Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Patient.identifier:BirthNotificationNo.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Patient.identifier:BirthNotificationNo.type | extensible | Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Patient.identifier:WonderId.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Patient.identifier:WonderId.type | extensible | Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Patient.name.use | required | NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1From the FHIR Standard | ||||
| Patient.telecom.system | required | ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1From the FHIR Standard | ||||
| Patient.telecom.use | required | ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1From the FHIR Standard | ||||
| Patient.gender | required | AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1From the FHIR Standard | ||||
| Patient.address.use | required | AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1From the FHIR Standard | ||||
| Patient.address.type | required | AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1From the FHIR Standard | ||||
| Patient.maritalStatus | extensible | Marital Status Codes http://hl7.org/fhir/ValueSet/marital-statusFrom the FHIR Standard | ||||
| Patient.contact.relationship | extensible | PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationshipFrom the FHIR Standard | ||||
| Patient.contact.gender | required | AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1From the FHIR Standard | ||||
| Patient.communication.language | preferred | CommonLanguages http://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard 
 | ||||
| Patient.link.type | required | LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1From the FHIR Standard | 
| Id | Grade | Path(s) | Details | Requirements | 
| MustHavePhoneNumber-1 | error | Patient | At least one telecom entry must have system = 'phone' and a value. : telecom.where(system = 'phone' and value.exists()).exists() | |
| PatientIdentification-1 | error | Patient | The Patient profile SHALL have at least one identifier "NationaID" or "BirthCertificate". : identifier.slice('http://example.org/StructureDefinition/ksm-patient','NationalIDNo').count() + identifier.slice('http://example.org/StructureDefinition/ksm-patient','BirthCertificateNo').count() > 0 | |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() | 
This structure is derived from Patient
Summary
Mandatory: 3 elements(18 nested mandatory elements)
 Must-Support: 25 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron