Kenya Patient Summary FHIR IG
0.1.0 - ci-build Kenya flag

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

Resource Profile: Patient Profile - KPS

Official URL: https://example.org/fhir/StructureDefinition/kps-patient Version: 0.1.0
Draft as of 2025-12-09 Computable Name: KpsPatient

This profile defines the constraints and extensions on the IPS Patient resource for use in the Kenya Patient Summary, supporting national HIE and continuity of care.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* PatientUvIps Information about an individual or animal receiving health care services
Constraints: PatientIdentification-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:UPI 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/UPI
..... 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
... name SΣC 1..* HumanName A name associated with the patient
Constraints: ips-pat-1
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text SΣ 0..1 string Text representation of the full name
.... family SΣ 0..1 string Family name (often called 'Surname')
.... given SΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... Slices for telecom SΣ 1..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by pattern:system
.... telecom:phone SΣ 1..1 ContactPoint A contact detail for the individual
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... telecom:email SΣ 0..1 ContactPoint A contact detail for the individual
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 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: KPSPatientGender (required)
... birthDate SΣ 1..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 SΣC 0..* Address An address for the individual
Constraints: pat-cnt-2or3-char
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... line SΣ 0..1 string Patient's Village of Resisence
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 Ward of Resisence
Example General: Erewhon
.... district SΣ 0..1 string Patient's Sub-County of Resisence
Example General: Madison
.... state SΣ 0..1 string Patient's County of Resisence
.... postalCode SΣ 0..1 string Patient's Postal Address of Resisence
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship S 1..1 CodeableConceptIPS Concept - reference to a terminology or just text
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
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
..... family SΣ 0..1 string Family name (often called 'Surname')
..... given SΣ 0..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... telecom S 1..1 ContactPoint A contact detail for the person
... generalPractitioner S 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier:NationalIDNo.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:UPI.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:PassportNo.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:BirthCertificateNo.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom:phone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:phone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required KPSPatientGender 📦0.1.0 This IG
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.0.1 FHIR Std.
Patient.contact.name.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
ips-pat-1 error Patient.name Patient.name.given, Patient.name.family or Patient.name.text SHALL be present family.exists() or given.exists() or text.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()
pat-cnt-2or3-char warning Patient.address The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))

This structure is derived from PatientUvIps

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* PatientUvIps Information about an individual or animal receiving health care services
Constraints: PatientIdentification-1
... Slices for identifier 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:UPI 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/UPI
..... 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
... Slices for telecom 1..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by pattern:system
.... telecom:phone 1..1 ContactPoint A contact detail for the individual
..... system 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: phone
..... value S 1..1 string The actual contact point details
..... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
.... telecom:email 0..1 ContactPoint A contact detail for the individual
..... system 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: email
..... value S 1..1 string The actual contact point details
..... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
... gender 1..1 code male | female | other | unknown
Binding: KPSPatientGender (required)
.... line S 0..1 string Patient's Village of Resisence
.... city S 0..1 string Patient's Ward of Resisence
.... district S 0..1 string Patient's Sub-County of Resisence
.... state S 0..1 string Patient's County of Resisence
.... postalCode S 0..1 string Patient's Postal Address of Resisence
.... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... contact
.... relationship S 1..1 CodeableConceptIPS Concept - reference to a terminology or just text
.... name
..... family S 0..1 string Family name (often called 'Surname')
..... given S 0..1 string Given names (not always 'first'). Includes middle names
.... telecom S 1..1 ContactPoint A contact detail for the person

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.gender Base required KPSPatientGender 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
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
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* PatientUvIps Information about an individual or animal receiving health care services
Constraints: PatientIdentification-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
... 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:UPI 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/UPI
..... 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)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣC 1..* HumanName A name associated with the patient
Constraints: ips-pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text SΣ 0..1 string Text representation of the full name
.... family SΣ 0..1 string Family name (often called 'Surname')
.... given SΣ 0..* string Given names (not always 'first'). Includes middle names
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
... Slices for telecom SΣ 1..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by pattern:system
.... telecom:phone SΣ 1..1 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 ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 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
.... telecom:email SΣ 0..1 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 ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 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: KPSPatientGender (required)
... birthDate SΣ 1..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 SΣC 0..* Address An address for the individual
Constraints: pat-cnt-2or3-char
.... 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 Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 0..1 string Patient's Village of Resisence
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 Ward of Resisence
Example General: Erewhon
.... district SΣ 0..1 string Patient's Sub-County of Resisence
Example General: Madison
.... state SΣ 0..1 string Patient's County of Resisence
.... postalCode SΣ 0..1 string Patient's Postal Address of Resisence
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.
... 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 S 1..1 CodeableConceptIPS Concept - reference to a terminology or just text
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
..... 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Σ 0..1 string Family name (often called 'Surname')
..... given SΣ 0..1 string Given names (not always 'first'). Includes middle names
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 1..1 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.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner S 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.identifier:NationalIDNo.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:NationalIDNo.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:UPI.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:UPI.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:PassportNo.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:PassportNo.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:BirthCertificateNo.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:BirthCertificateNo.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom:phone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:phone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required KPSPatientGender 📦0.1.0 This IG
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.maritalStatus Base extensible MaritalStatus 📦4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.0.1 FHIR Std.
Patient.contact.name.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
ips-pat-1 error Patient.name Patient.name.given, Patient.name.family or Patient.name.text SHALL be present family.exists() or given.exists() or text.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()
pat-cnt-2or3-char warning Patient.address The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))

This structure is derived from PatientUvIps

Summary

Mandatory: 6 elements(12 nested mandatory elements)
Must-Support: 18 elements
Fixed: 2 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.identifier
  • The element 1 is sliced based on the value of Patient.telecom

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* PatientUvIps Information about an individual or animal receiving health care services
Constraints: PatientIdentification-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:UPI 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/UPI
..... 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
... name SΣC 1..* HumanName A name associated with the patient
Constraints: ips-pat-1
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text SΣ 0..1 string Text representation of the full name
.... family SΣ 0..1 string Family name (often called 'Surname')
.... given SΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... Slices for telecom SΣ 1..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by pattern:system
.... telecom:phone SΣ 1..1 ContactPoint A contact detail for the individual
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... telecom:email SΣ 0..1 ContactPoint A contact detail for the individual
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 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: KPSPatientGender (required)
... birthDate SΣ 1..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 SΣC 0..* Address An address for the individual
Constraints: pat-cnt-2or3-char
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... line SΣ 0..1 string Patient's Village of Resisence
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 Ward of Resisence
Example General: Erewhon
.... district SΣ 0..1 string Patient's Sub-County of Resisence
Example General: Madison
.... state SΣ 0..1 string Patient's County of Resisence
.... postalCode SΣ 0..1 string Patient's Postal Address of Resisence
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship S 1..1 CodeableConceptIPS Concept - reference to a terminology or just text
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
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
..... family SΣ 0..1 string Family name (often called 'Surname')
..... given SΣ 0..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... telecom S 1..1 ContactPoint A contact detail for the person
... generalPractitioner S 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier:NationalIDNo.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:UPI.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:PassportNo.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:BirthCertificateNo.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom:phone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:phone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required KPSPatientGender 📦0.1.0 This IG
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.0.1 FHIR Std.
Patient.contact.name.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
ips-pat-1 error Patient.name Patient.name.given, Patient.name.family or Patient.name.text SHALL be present family.exists() or given.exists() or text.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()
pat-cnt-2or3-char warning Patient.address The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))

Differential View

This structure is derived from PatientUvIps

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* PatientUvIps Information about an individual or animal receiving health care services
Constraints: PatientIdentification-1
... Slices for identifier 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:UPI 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/UPI
..... 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
... Slices for telecom 1..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by pattern:system
.... telecom:phone 1..1 ContactPoint A contact detail for the individual
..... system 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: phone
..... value S 1..1 string The actual contact point details
..... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
.... telecom:email 0..1 ContactPoint A contact detail for the individual
..... system 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: email
..... value S 1..1 string The actual contact point details
..... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
... gender 1..1 code male | female | other | unknown
Binding: KPSPatientGender (required)
.... line S 0..1 string Patient's Village of Resisence
.... city S 0..1 string Patient's Ward of Resisence
.... district S 0..1 string Patient's Sub-County of Resisence
.... state S 0..1 string Patient's County of Resisence
.... postalCode S 0..1 string Patient's Postal Address of Resisence
.... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... contact
.... relationship S 1..1 CodeableConceptIPS Concept - reference to a terminology or just text
.... name
..... family S 0..1 string Family name (often called 'Surname')
..... given S 0..1 string Given names (not always 'first'). Includes middle names
.... telecom S 1..1 ContactPoint A contact detail for the person

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.gender Base required KPSPatientGender 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* PatientUvIps Information about an individual or animal receiving health care services
Constraints: PatientIdentification-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
... 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:UPI 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/UPI
..... 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)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣC 1..* HumanName A name associated with the patient
Constraints: ips-pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text SΣ 0..1 string Text representation of the full name
.... family SΣ 0..1 string Family name (often called 'Surname')
.... given SΣ 0..* string Given names (not always 'first'). Includes middle names
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
... Slices for telecom SΣ 1..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by pattern:system
.... telecom:phone SΣ 1..1 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 ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 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
.... telecom:email SΣ 0..1 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 ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 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: KPSPatientGender (required)
... birthDate SΣ 1..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 SΣC 0..* Address An address for the individual
Constraints: pat-cnt-2or3-char
.... 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 Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 0..1 string Patient's Village of Resisence
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 Ward of Resisence
Example General: Erewhon
.... district SΣ 0..1 string Patient's Sub-County of Resisence
Example General: Madison
.... state SΣ 0..1 string Patient's County of Resisence
.... postalCode SΣ 0..1 string Patient's Postal Address of Resisence
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.
... 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 S 1..1 CodeableConceptIPS Concept - reference to a terminology or just text
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
..... 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Σ 0..1 string Family name (often called 'Surname')
..... given SΣ 0..1 string Given names (not always 'first'). Includes middle names
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 1..1 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.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner S 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.identifier:NationalIDNo.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:NationalIDNo.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:UPI.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:UPI.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:PassportNo.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:PassportNo.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:BirthCertificateNo.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:BirthCertificateNo.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom:phone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:phone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required KPSPatientGender 📦0.1.0 This IG
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.maritalStatus Base extensible MaritalStatus 📦4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.0.1 FHIR Std.
Patient.contact.name.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
ips-pat-1 error Patient.name Patient.name.given, Patient.name.family or Patient.name.text SHALL be present family.exists() or given.exists() or text.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()
pat-cnt-2or3-char warning Patient.address The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))

This structure is derived from PatientUvIps

Summary

Mandatory: 6 elements(12 nested mandatory elements)
Must-Support: 18 elements
Fixed: 2 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.identifier
  • The element 1 is sliced based on the value of Patient.telecom

 

Other representations of profile: CSV, Excel, Schematron