DHIN 2025Connectathon FHIR IG
0.1.0 - draft

DHIN 2025Connectathon FHIR IG, published by DHIN. 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/Nigeria-FHIR-Community/2025Connectathon/ and changes regularly. See the Directory of published versions

Resource Profile: NG Patient

Official URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/NgPatient Version: 0.1.0
Draft as of 2025-10-21 Computable Name: NgPatient

Nigeria 2025 Connectathon Patient Profile

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 0..* Patient Information about an individual or animal receiving health care services
... meta Σ 0..1 Meta Metadata about the resource
.... lastUpdated SΣ 1..1 instant The date and time when the client record was created or last updated.
... Slices for identifier SΣ 1..* Identifier The identifier set given to a Client at different points (can be the National ID, the Hospital specific MRN, Connectathon number, or even phone number)
Slice: Unordered, Open by value:type.coding.code
.... identifier:All Slices Content/Rules for all slices
.... identifier:NationalIDNo SΣ 0..1 Identifier An identifier for this patient
..... system Σ 0..1 uri NIMC's identifier in the system autheticated to https://nimc.org/nin
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value Σ 1..1 string The NIN number of the client which is a unique 11 digit number
Example General: 123456
.... identifier:MedicalRecordsNumber SΣ 0..1 Identifier An identifier for this patient
..... system Σ 0..1 uri The institution issuing the MRN number (e.g., Asokoro Hospital) validated at http://asokoro.org/medicalrecord-no
Example General: http://www.acme.com/identifiers/patient
Example Example MRN system: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value Σ 1..1 string The specific medical number value given the client at a health institution
Example General: 123456
.... identifier:BirthCertificateNo SΣ 0..1 Identifier An identifier for this patient
..... system Σ 0..1 uri The institution generating the birth certificate number (e.g., NPC)
Example General: http://www.acme.com/identifiers/patient
Example Example Birth Certificate number system: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value Σ 1..1 string The client's birth certificate number
Example General: 123456
.... identifier:PhoneNumber SΣ 0..1 Identifier An identifier for this patient
..... system Σ 0..1 uri The provider of the phone number (e.g., MTN)
Example General: http://www.acme.com/identifiers/patient
Example Example Phone Number system: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value Σ 1..1 string Client's phone number which is 11 digits
Example General: 123456
.... identifier:InsuranceNumber SΣ 0..1 Identifier An identifier for this patient
..... system Σ 0..1 uri The generating institution e.g., State, NHIA, or HMO
Example General: http://www.acme.com/identifiers/patient
Example Example Insurance system: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value Σ 1..1 string The actual insurance number generated at state, national or HMO authorities
Example General: 123456
... active ?!Σ 0..1 boolean Indicates whether this client's record is in active use or not
.... family Σ 1..1 string The surname or family name of the client
.... given Σ 1..* string The other names of the client like the Firstname and Middle names if applicable
This repeating element order: Given Names appear in the correct order for presenting the name
... gender Σ 0..1 code The sex of the client
Binding: NG Gender or Sex VS (required)
... birthDate SΣ 0..1 date The date of birth of the client in the form dd-mm-yyy
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address An address for the individual
.... Slices for extension Content/Rules for all slices
..... extension:administrativeWard S 0..1 CodeableConcept NG Administrative Wards
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/nigeria-administrative-ward
Binding: NG Wards VS (preferred)
.... line Σ 0..1 string The house number, street, and name where the client lives
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string The city, village, town or settlement where the client lives
Example General: Erewhon
.... district Σ 0..1 string The FHIR name is district, used as Nigeria LGA in this profile
Binding: NG LGAs VS (required)
Example General: Madison
.... state Σ 0..1 string The name of the state where the client resides in Nigeria
Binding: NG States VS (required)
... contact SC 0..* BackboneElement The contact information of the client's primary Caregiver, can be a Parent or Guardian
Constraints: pat-1
.... telecom S 0..* ContactPoint A contact detail for the person
..... system ΣC 0..1 code The primary means to contact the client's primary Caregiver or Guardian
Binding: ContactPointSystem (required): Telecommunications form for contact point.
..... value Σ 0..1 string The primary phone/email of the client's primary Caregiver or Guardian
.... address 0..1 Address Address for the contact person
..... Slices for extension Content/Rules for all slices
...... extension:administrativeWard S 0..1 CodeableConcept NG Administrative Wards
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/nigeria-administrative-ward
Binding: NG Wards VS (preferred)
..... line SΣ 0..1 string The line address of the client's primary Caregiver or Guardian
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city Σ 0..1 string The city, town or settlement where the client's primary Caregiver or Guardian lives
Example General: Erewhon
..... district Σ 0..1 string The LGA where the client's primary Caregiver or Guardian lives
Binding: NG LGAs VS (required)
Example General: Madison
..... state Σ 0..1 string The State in Nigeria where the client's primary Caregiver or Guardian lives
Binding: NG States VS (required)
... link ?!Σ 0..1 BackboneElement Link to another patient resource that concerns the same actual person
.... other Σ 1..1 Reference(NG RelatedPerson) This link provides reference to the client's related persons
.... type Σ 1..1 code The type of Link (eg. reference) client's related persons
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.gender Base required NG Gender or Sex VS 📦0.1.0 This IG
Patient.address.district Base required NG LGAs VS 📦0.1.0 This IG
Patient.address.state Base required NG States VS 📦0.1.0 This IG
Patient.contact.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.contact.address.​district Base required NG LGAs VS 📦0.1.0 This IG
Patient.contact.address.​state Base required NG States VS 📦0.1.0 This IG
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... meta
.... lastUpdated S 1..1 instant The date and time when the client record was created or last updated.
... implicitRules 0..0
... modifierExtension 0..0
.... identifier:All Slices Content/Rules for all slices
..... use 0..0
.... identifier:NationalIDNo S 0..1 Identifier An identifier for this patient
..... use 0..0
..... type
...... coding
....... system 0..1 uri Identity of the terminology system
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: NIN
....... display 0..1 string Representation defined by the system
Required Pattern: National Identity Number of Client or Caregiver
..... system 0..1 uri NIMC's identifier in the system autheticated to https://nimc.org/nin
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value 1..1 string The NIN number of the client which is a unique 11 digit number
.... identifier:MedicalRecordsNumber S 0..1 Identifier An identifier for this patient
..... use 0..0
..... type
...... coding
....... system 0..1 uri Identity of the terminology system
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: MRN
....... display 0..1 string Representation defined by the system
Required Pattern: Medical Record Number
..... system 0..1 uri The institution issuing the MRN number (e.g., Asokoro Hospital) validated at http://asokoro.org/medicalrecord-no
Example Example MRN system: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value 1..1 string The specific medical number value given the client at a health institution
.... identifier:BirthCertificateNo S 0..1 Identifier An identifier for this patient
..... use 0..0
..... type
...... coding
....... system 0..1 uri Identity of the terminology system
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: BIRTHCERT
....... display 0..1 string Representation defined by the system
Required Pattern: Birth Certificate Number
..... system 0..1 uri The institution generating the birth certificate number (e.g., NPC)
Example Example Birth Certificate number system: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value 1..1 string The client's birth certificate number
.... identifier:PhoneNumber S 0..1 Identifier An identifier for this patient
..... use 0..0
..... type
...... coding
....... system 0..1 uri Identity of the terminology system
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: MOBILE
....... display 0..1 string Representation defined by the system
Required Pattern: Primary Mobile Phone Number of the Client or CareGiver
..... system 0..1 uri The provider of the phone number (e.g., MTN)
Example Example Phone Number system: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value 1..1 string Client's phone number which is 11 digits
.... identifier:InsuranceNumber S 0..1 Identifier An identifier for this patient
..... use 0..0
..... type
...... coding
....... system 0..1 uri Identity of the terminology system
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: INSUR
....... display 0..1 string Representation defined by the system
Required Pattern: The Insurance or HMO number of the client
..... system 0..1 uri The generating institution e.g., State, NHIA, or HMO
Example Example Insurance system: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value 1..1 string The actual insurance number generated at state, national or HMO authorities
... active 0..1 boolean Indicates whether this client's record is in active use or not
... name S 1..1 HumanName A name associated with the patient
.... use 0..0
.... family 1..1 string The surname or family name of the client
.... given 1..* string The other names of the client like the Firstname and Middle names if applicable
... gender 0..1 code The sex of the client
Binding: NG Gender or Sex VS (required)
... birthDate S 0..1 date The date of birth of the client in the form dd-mm-yyy
... address S 0..* Address An address for the individual
.... Slices for extension Content/Rules for all slices
..... extension:administrativeWard S 0..1 CodeableConcept NG Administrative Wards
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/nigeria-administrative-ward
Binding: NG Wards VS (preferred)
.... use 0..0
.... line 0..1 string The house number, street, and name where the client lives
.... city 0..1 string The city, village, town or settlement where the client lives
.... district 0..1 string The FHIR name is district, used as Nigeria LGA in this profile
Binding: NG LGAs VS (required)
.... state 0..1 string The name of the state where the client resides in Nigeria
Binding: NG States VS (required)
... contact S 0..* BackboneElement The contact information of the client's primary Caregiver, can be a Parent or Guardian
.... modifierExtension 0..0
.... relationship
..... text 0..1 string The relationship of the client with the primary Caregiver or Guardian (eg. Parent)
Binding: NG Relationships VS (extensible)
.... name
..... use 0..0
..... family 0..1 string The surname (family) name of the client's primary Caregiver, can be a Parent or Guardian
..... given 0..* string The first name of the client's primary Caregiver, can be a Parent or Guardian
.... telecom S 0..* ContactPoint A contact detail for the person
..... system 0..1 code The primary means to contact the client's primary Caregiver or Guardian
..... value 0..1 string The primary phone/email of the client's primary Caregiver or Guardian
..... use 0..0
.... address
..... Slices for extension Content/Rules for all slices
...... extension:administrativeWard S 0..1 CodeableConcept NG Administrative Wards
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/nigeria-administrative-ward
Binding: NG Wards VS (preferred)
..... use 0..0
..... line S 0..1 string The line address of the client's primary Caregiver or Guardian
..... city 0..1 string The city, town or settlement where the client's primary Caregiver or Guardian lives
..... district 0..1 string The LGA where the client's primary Caregiver or Guardian lives
Binding: NG LGAs VS (required)
..... state 0..1 string The State in Nigeria where the client's primary Caregiver or Guardian lives
Binding: NG States VS (required)
... link 0..1 BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension 0..0
.... other 1..1 Reference(NG RelatedPerson) This link provides reference to the client's related persons
.... type 1..1 code The type of Link (eg. reference) client's related persons

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.gender Base required NG Gender or Sex VS 📦0.1.0 This IG
Patient.address.district Base required NG LGAs VS 📦0.1.0 This IG
Patient.address.state Base required NG States VS 📦0.1.0 This IG
Patient.contact.relationship.​text Base extensible NG Relationships VS 📦0.1.0 This IG
Patient.contact.address.​district Base required NG LGAs VS 📦0.1.0 This IG
Patient.contact.address.​state Base required NG States VS 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 1..1 instant The date and time when the client record was created or last updated.
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... Slices for identifier SΣ 1..* Identifier The identifier set given to a Client at different points (can be the National ID, the Hospital specific MRN, Connectathon number, or even phone number)
Slice: Unordered, Open by value:type.coding.code
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... 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 Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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: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
..... 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.
...... 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 Σ 0..1 uri Identity of the terminology system
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: NIN
....... display Σ 0..1 string Representation defined by the system
Required Pattern: National Identity Number of Client or Caregiver
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri NIMC's identifier in the system autheticated to https://nimc.org/nin
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value Σ 1..1 string The NIN number of the client which is a unique 11 digit number
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:MedicalRecordsNumber 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
..... 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.
...... 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 Σ 0..1 uri Identity of the terminology system
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: MRN
....... display Σ 0..1 string Representation defined by the system
Required Pattern: Medical Record Number
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The institution issuing the MRN number (e.g., Asokoro Hospital) validated at http://asokoro.org/medicalrecord-no
Example General: http://www.acme.com/identifiers/patient
Example Example MRN system: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value Σ 1..1 string The specific medical number value given the client at a health institution
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
..... 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.
...... 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 Σ 0..1 uri Identity of the terminology system
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: BIRTHCERT
....... display Σ 0..1 string Representation defined by the system
Required Pattern: Birth Certificate Number
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The institution generating the birth certificate number (e.g., NPC)
Example General: http://www.acme.com/identifiers/patient
Example Example Birth Certificate number system: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value Σ 1..1 string The client's birth certificate number
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:PhoneNumber 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
..... 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.
...... 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 Σ 0..1 uri Identity of the terminology system
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: MOBILE
....... display Σ 0..1 string Representation defined by the system
Required Pattern: Primary Mobile Phone Number of the Client or CareGiver
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The provider of the phone number (e.g., MTN)
Example General: http://www.acme.com/identifiers/patient
Example Example Phone Number system: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value Σ 1..1 string Client's phone number which is 11 digits
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:InsuranceNumber 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
..... 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.
...... 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 Σ 0..1 uri Identity of the terminology system
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: INSUR
....... display Σ 0..1 string Representation defined by the system
Required Pattern: The Insurance or HMO number of the client
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The generating institution e.g., State, NHIA, or HMO
Example General: http://www.acme.com/identifiers/patient
Example Example Insurance system: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value Σ 1..1 string The actual insurance number generated at state, national or HMO authorities
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 Indicates whether this client's record is in active use or not
... name SΣ 1..1 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
.... text Σ 0..1 string Text representation of the full name
.... family Σ 1..1 string The surname or family name of the client
.... given Σ 1..* string The other names of the client like the Firstname and Middle names if applicable
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 Σ 0..* ContactPoint A contact detail for the individual
... gender Σ 0..1 code The sex of the client
Binding: NG Gender or Sex VS (required)
... birthDate SΣ 0..1 date The date of birth of the client in the form dd-mm-yyy
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address An address for the individual
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:administrativeWard S 0..1 CodeableConcept NG Administrative Wards
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/nigeria-administrative-ward
Binding: NG Wards VS (preferred)
.... 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 Σ 0..1 string The house number, street, and name where the client lives
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string The city, village, town or settlement where the client lives
Example General: Erewhon
.... district Σ 0..1 string The FHIR name is district, used as Nigeria LGA in this profile
Binding: NG LGAs VS (required)
Example General: Madison
.... state Σ 0..1 string The name of the state where the client resides in Nigeria
Binding: NG States VS (required)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 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 SC 0..* BackboneElement The contact information of the client's primary Caregiver, can be a Parent or Guardian
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... 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.
..... 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
..... text Σ 0..1 string The relationship of the client with the primary Caregiver or Guardian (eg. Parent)
Binding: NG Relationships VS (extensible)
.... 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
..... text Σ 0..1 string Text representation of the full name
..... family Σ 0..1 string The surname (family) name of the client's primary Caregiver, can be a Parent or Guardian
..... given Σ 0..* string The first name of the client's primary Caregiver, can be a Parent or Guardian
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 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
..... system ΣC 0..1 code The primary means to contact the client's primary Caregiver or Guardian
Binding: ContactPointSystem (required): Telecommunications form for contact point.
..... value Σ 0..1 string The primary phone/email of the client's primary Caregiver or Guardian
..... 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
.... address 0..1 Address Address for the contact person
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:administrativeWard S 0..1 CodeableConcept NG Administrative Wards
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/nigeria-administrative-ward
Binding: NG Wards VS (preferred)
..... 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 The line address of the client's primary Caregiver or Guardian
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city Σ 0..1 string The city, town or settlement where the client's primary Caregiver or Guardian lives
Example General: Erewhon
..... district Σ 0..1 string The LGA where the client's primary Caregiver or Guardian lives
Binding: NG LGAs VS (required)
Example General: Madison
..... state Σ 0..1 string The State in Nigeria where the client's primary Caregiver or Guardian lives
Binding: NG States VS (required)
..... postalCode Σ 0..1 string Postal code for area
Example General: 9132
..... country Σ 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"}
.... 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 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..1 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
.... other Σ 1..1 Reference(NG RelatedPerson) This link provides reference to the client's related persons
.... type Σ 1..1 code The type of Link (eg. reference) client's related persons
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.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Patient.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:NationalIDNo.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:MedicalRecordsNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:BirthCertificateNo.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:PhoneNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:InsuranceNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.gender Base required NG Gender or Sex VS 📦0.1.0 This IG
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address.district Base required NG LGAs VS 📦0.1.0 This IG
Patient.address.state Base required NG States VS 📦0.1.0 This IG
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.relationship.​text Base extensible NG Relationships VS 📦0.1.0 This IG
Patient.contact.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.contact.address.​type Base required AddressType 📍4.0.1 FHIR Std.
Patient.contact.address.​district Base required NG LGAs VS 📦0.1.0 This IG
Patient.contact.address.​state Base required NG States VS 📦0.1.0 This IG
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
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: 4 elements(11 nested mandatory elements)
Must-Support: 15 elements
Prohibited: 15 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... meta Σ 0..1 Meta Metadata about the resource
.... lastUpdated SΣ 1..1 instant The date and time when the client record was created or last updated.
... Slices for identifier SΣ 1..* Identifier The identifier set given to a Client at different points (can be the National ID, the Hospital specific MRN, Connectathon number, or even phone number)
Slice: Unordered, Open by value:type.coding.code
.... identifier:All Slices Content/Rules for all slices
.... identifier:NationalIDNo SΣ 0..1 Identifier An identifier for this patient
..... system Σ 0..1 uri NIMC's identifier in the system autheticated to https://nimc.org/nin
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value Σ 1..1 string The NIN number of the client which is a unique 11 digit number
Example General: 123456
.... identifier:MedicalRecordsNumber SΣ 0..1 Identifier An identifier for this patient
..... system Σ 0..1 uri The institution issuing the MRN number (e.g., Asokoro Hospital) validated at http://asokoro.org/medicalrecord-no
Example General: http://www.acme.com/identifiers/patient
Example Example MRN system: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value Σ 1..1 string The specific medical number value given the client at a health institution
Example General: 123456
.... identifier:BirthCertificateNo SΣ 0..1 Identifier An identifier for this patient
..... system Σ 0..1 uri The institution generating the birth certificate number (e.g., NPC)
Example General: http://www.acme.com/identifiers/patient
Example Example Birth Certificate number system: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value Σ 1..1 string The client's birth certificate number
Example General: 123456
.... identifier:PhoneNumber SΣ 0..1 Identifier An identifier for this patient
..... system Σ 0..1 uri The provider of the phone number (e.g., MTN)
Example General: http://www.acme.com/identifiers/patient
Example Example Phone Number system: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value Σ 1..1 string Client's phone number which is 11 digits
Example General: 123456
.... identifier:InsuranceNumber SΣ 0..1 Identifier An identifier for this patient
..... system Σ 0..1 uri The generating institution e.g., State, NHIA, or HMO
Example General: http://www.acme.com/identifiers/patient
Example Example Insurance system: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value Σ 1..1 string The actual insurance number generated at state, national or HMO authorities
Example General: 123456
... active ?!Σ 0..1 boolean Indicates whether this client's record is in active use or not
.... family Σ 1..1 string The surname or family name of the client
.... given Σ 1..* string The other names of the client like the Firstname and Middle names if applicable
This repeating element order: Given Names appear in the correct order for presenting the name
... gender Σ 0..1 code The sex of the client
Binding: NG Gender or Sex VS (required)
... birthDate SΣ 0..1 date The date of birth of the client in the form dd-mm-yyy
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address An address for the individual
.... Slices for extension Content/Rules for all slices
..... extension:administrativeWard S 0..1 CodeableConcept NG Administrative Wards
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/nigeria-administrative-ward
Binding: NG Wards VS (preferred)
.... line Σ 0..1 string The house number, street, and name where the client lives
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string The city, village, town or settlement where the client lives
Example General: Erewhon
.... district Σ 0..1 string The FHIR name is district, used as Nigeria LGA in this profile
Binding: NG LGAs VS (required)
Example General: Madison
.... state Σ 0..1 string The name of the state where the client resides in Nigeria
Binding: NG States VS (required)
... contact SC 0..* BackboneElement The contact information of the client's primary Caregiver, can be a Parent or Guardian
Constraints: pat-1
.... telecom S 0..* ContactPoint A contact detail for the person
..... system ΣC 0..1 code The primary means to contact the client's primary Caregiver or Guardian
Binding: ContactPointSystem (required): Telecommunications form for contact point.
..... value Σ 0..1 string The primary phone/email of the client's primary Caregiver or Guardian
.... address 0..1 Address Address for the contact person
..... Slices for extension Content/Rules for all slices
...... extension:administrativeWard S 0..1 CodeableConcept NG Administrative Wards
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/nigeria-administrative-ward
Binding: NG Wards VS (preferred)
..... line SΣ 0..1 string The line address of the client's primary Caregiver or Guardian
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city Σ 0..1 string The city, town or settlement where the client's primary Caregiver or Guardian lives
Example General: Erewhon
..... district Σ 0..1 string The LGA where the client's primary Caregiver or Guardian lives
Binding: NG LGAs VS (required)
Example General: Madison
..... state Σ 0..1 string The State in Nigeria where the client's primary Caregiver or Guardian lives
Binding: NG States VS (required)
... link ?!Σ 0..1 BackboneElement Link to another patient resource that concerns the same actual person
.... other Σ 1..1 Reference(NG RelatedPerson) This link provides reference to the client's related persons
.... type Σ 1..1 code The type of Link (eg. reference) client's related persons
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.gender Base required NG Gender or Sex VS 📦0.1.0 This IG
Patient.address.district Base required NG LGAs VS 📦0.1.0 This IG
Patient.address.state Base required NG States VS 📦0.1.0 This IG
Patient.contact.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.contact.address.​district Base required NG LGAs VS 📦0.1.0 This IG
Patient.contact.address.​state Base required NG States VS 📦0.1.0 This IG
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

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

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... meta
.... lastUpdated S 1..1 instant The date and time when the client record was created or last updated.
... implicitRules 0..0
... modifierExtension 0..0
.... identifier:All Slices Content/Rules for all slices
..... use 0..0
.... identifier:NationalIDNo S 0..1 Identifier An identifier for this patient
..... use 0..0
..... type
...... coding
....... system 0..1 uri Identity of the terminology system
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: NIN
....... display 0..1 string Representation defined by the system
Required Pattern: National Identity Number of Client or Caregiver
..... system 0..1 uri NIMC's identifier in the system autheticated to https://nimc.org/nin
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value 1..1 string The NIN number of the client which is a unique 11 digit number
.... identifier:MedicalRecordsNumber S 0..1 Identifier An identifier for this patient
..... use 0..0
..... type
...... coding
....... system 0..1 uri Identity of the terminology system
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: MRN
....... display 0..1 string Representation defined by the system
Required Pattern: Medical Record Number
..... system 0..1 uri The institution issuing the MRN number (e.g., Asokoro Hospital) validated at http://asokoro.org/medicalrecord-no
Example Example MRN system: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value 1..1 string The specific medical number value given the client at a health institution
.... identifier:BirthCertificateNo S 0..1 Identifier An identifier for this patient
..... use 0..0
..... type
...... coding
....... system 0..1 uri Identity of the terminology system
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: BIRTHCERT
....... display 0..1 string Representation defined by the system
Required Pattern: Birth Certificate Number
..... system 0..1 uri The institution generating the birth certificate number (e.g., NPC)
Example Example Birth Certificate number system: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value 1..1 string The client's birth certificate number
.... identifier:PhoneNumber S 0..1 Identifier An identifier for this patient
..... use 0..0
..... type
...... coding
....... system 0..1 uri Identity of the terminology system
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: MOBILE
....... display 0..1 string Representation defined by the system
Required Pattern: Primary Mobile Phone Number of the Client or CareGiver
..... system 0..1 uri The provider of the phone number (e.g., MTN)
Example Example Phone Number system: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value 1..1 string Client's phone number which is 11 digits
.... identifier:InsuranceNumber S 0..1 Identifier An identifier for this patient
..... use 0..0
..... type
...... coding
....... system 0..1 uri Identity of the terminology system
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: INSUR
....... display 0..1 string Representation defined by the system
Required Pattern: The Insurance or HMO number of the client
..... system 0..1 uri The generating institution e.g., State, NHIA, or HMO
Example Example Insurance system: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value 1..1 string The actual insurance number generated at state, national or HMO authorities
... active 0..1 boolean Indicates whether this client's record is in active use or not
... name S 1..1 HumanName A name associated with the patient
.... use 0..0
.... family 1..1 string The surname or family name of the client
.... given 1..* string The other names of the client like the Firstname and Middle names if applicable
... gender 0..1 code The sex of the client
Binding: NG Gender or Sex VS (required)
... birthDate S 0..1 date The date of birth of the client in the form dd-mm-yyy
... address S 0..* Address An address for the individual
.... Slices for extension Content/Rules for all slices
..... extension:administrativeWard S 0..1 CodeableConcept NG Administrative Wards
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/nigeria-administrative-ward
Binding: NG Wards VS (preferred)
.... use 0..0
.... line 0..1 string The house number, street, and name where the client lives
.... city 0..1 string The city, village, town or settlement where the client lives
.... district 0..1 string The FHIR name is district, used as Nigeria LGA in this profile
Binding: NG LGAs VS (required)
.... state 0..1 string The name of the state where the client resides in Nigeria
Binding: NG States VS (required)
... contact S 0..* BackboneElement The contact information of the client's primary Caregiver, can be a Parent or Guardian
.... modifierExtension 0..0
.... relationship
..... text 0..1 string The relationship of the client with the primary Caregiver or Guardian (eg. Parent)
Binding: NG Relationships VS (extensible)
.... name
..... use 0..0
..... family 0..1 string The surname (family) name of the client's primary Caregiver, can be a Parent or Guardian
..... given 0..* string The first name of the client's primary Caregiver, can be a Parent or Guardian
.... telecom S 0..* ContactPoint A contact detail for the person
..... system 0..1 code The primary means to contact the client's primary Caregiver or Guardian
..... value 0..1 string The primary phone/email of the client's primary Caregiver or Guardian
..... use 0..0
.... address
..... Slices for extension Content/Rules for all slices
...... extension:administrativeWard S 0..1 CodeableConcept NG Administrative Wards
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/nigeria-administrative-ward
Binding: NG Wards VS (preferred)
..... use 0..0
..... line S 0..1 string The line address of the client's primary Caregiver or Guardian
..... city 0..1 string The city, town or settlement where the client's primary Caregiver or Guardian lives
..... district 0..1 string The LGA where the client's primary Caregiver or Guardian lives
Binding: NG LGAs VS (required)
..... state 0..1 string The State in Nigeria where the client's primary Caregiver or Guardian lives
Binding: NG States VS (required)
... link 0..1 BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension 0..0
.... other 1..1 Reference(NG RelatedPerson) This link provides reference to the client's related persons
.... type 1..1 code The type of Link (eg. reference) client's related persons

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.gender Base required NG Gender or Sex VS 📦0.1.0 This IG
Patient.address.district Base required NG LGAs VS 📦0.1.0 This IG
Patient.address.state Base required NG States VS 📦0.1.0 This IG
Patient.contact.relationship.​text Base extensible NG Relationships VS 📦0.1.0 This IG
Patient.contact.address.​district Base required NG LGAs VS 📦0.1.0 This IG
Patient.contact.address.​state Base required NG States VS 📦0.1.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 1..1 instant The date and time when the client record was created or last updated.
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... Slices for identifier SΣ 1..* Identifier The identifier set given to a Client at different points (can be the National ID, the Hospital specific MRN, Connectathon number, or even phone number)
Slice: Unordered, Open by value:type.coding.code
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... 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 Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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: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
..... 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.
...... 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 Σ 0..1 uri Identity of the terminology system
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: NIN
....... display Σ 0..1 string Representation defined by the system
Required Pattern: National Identity Number of Client or Caregiver
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri NIMC's identifier in the system autheticated to https://nimc.org/nin
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value Σ 1..1 string The NIN number of the client which is a unique 11 digit number
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:MedicalRecordsNumber 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
..... 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.
...... 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 Σ 0..1 uri Identity of the terminology system
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: MRN
....... display Σ 0..1 string Representation defined by the system
Required Pattern: Medical Record Number
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The institution issuing the MRN number (e.g., Asokoro Hospital) validated at http://asokoro.org/medicalrecord-no
Example General: http://www.acme.com/identifiers/patient
Example Example MRN system: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value Σ 1..1 string The specific medical number value given the client at a health institution
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
..... 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.
...... 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 Σ 0..1 uri Identity of the terminology system
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: BIRTHCERT
....... display Σ 0..1 string Representation defined by the system
Required Pattern: Birth Certificate Number
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The institution generating the birth certificate number (e.g., NPC)
Example General: http://www.acme.com/identifiers/patient
Example Example Birth Certificate number system: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value Σ 1..1 string The client's birth certificate number
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:PhoneNumber 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
..... 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.
...... 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 Σ 0..1 uri Identity of the terminology system
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: MOBILE
....... display Σ 0..1 string Representation defined by the system
Required Pattern: Primary Mobile Phone Number of the Client or CareGiver
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The provider of the phone number (e.g., MTN)
Example General: http://www.acme.com/identifiers/patient
Example Example Phone Number system: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value Σ 1..1 string Client's phone number which is 11 digits
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:InsuranceNumber 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
..... 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.
...... 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 Σ 0..1 uri Identity of the terminology system
Required Pattern: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: INSUR
....... display Σ 0..1 string Representation defined by the system
Required Pattern: The Insurance or HMO number of the client
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The generating institution e.g., State, NHIA, or HMO
Example General: http://www.acme.com/identifiers/patient
Example Example Insurance system: https://sandbox.dhin-hie.org/ig/CodeSystem/patient-identifier-cs
..... value Σ 1..1 string The actual insurance number generated at state, national or HMO authorities
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 Indicates whether this client's record is in active use or not
... name SΣ 1..1 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
.... text Σ 0..1 string Text representation of the full name
.... family Σ 1..1 string The surname or family name of the client
.... given Σ 1..* string The other names of the client like the Firstname and Middle names if applicable
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 Σ 0..* ContactPoint A contact detail for the individual
... gender Σ 0..1 code The sex of the client
Binding: NG Gender or Sex VS (required)
... birthDate SΣ 0..1 date The date of birth of the client in the form dd-mm-yyy
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address An address for the individual
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:administrativeWard S 0..1 CodeableConcept NG Administrative Wards
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/nigeria-administrative-ward
Binding: NG Wards VS (preferred)
.... 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 Σ 0..1 string The house number, street, and name where the client lives
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string The city, village, town or settlement where the client lives
Example General: Erewhon
.... district Σ 0..1 string The FHIR name is district, used as Nigeria LGA in this profile
Binding: NG LGAs VS (required)
Example General: Madison
.... state Σ 0..1 string The name of the state where the client resides in Nigeria
Binding: NG States VS (required)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 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 SC 0..* BackboneElement The contact information of the client's primary Caregiver, can be a Parent or Guardian
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... 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.
..... 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
..... text Σ 0..1 string The relationship of the client with the primary Caregiver or Guardian (eg. Parent)
Binding: NG Relationships VS (extensible)
.... 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
..... text Σ 0..1 string Text representation of the full name
..... family Σ 0..1 string The surname (family) name of the client's primary Caregiver, can be a Parent or Guardian
..... given Σ 0..* string The first name of the client's primary Caregiver, can be a Parent or Guardian
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 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
..... system ΣC 0..1 code The primary means to contact the client's primary Caregiver or Guardian
Binding: ContactPointSystem (required): Telecommunications form for contact point.
..... value Σ 0..1 string The primary phone/email of the client's primary Caregiver or Guardian
..... 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
.... address 0..1 Address Address for the contact person
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:administrativeWard S 0..1 CodeableConcept NG Administrative Wards
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/nigeria-administrative-ward
Binding: NG Wards VS (preferred)
..... 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 The line address of the client's primary Caregiver or Guardian
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city Σ 0..1 string The city, town or settlement where the client's primary Caregiver or Guardian lives
Example General: Erewhon
..... district Σ 0..1 string The LGA where the client's primary Caregiver or Guardian lives
Binding: NG LGAs VS (required)
Example General: Madison
..... state Σ 0..1 string The State in Nigeria where the client's primary Caregiver or Guardian lives
Binding: NG States VS (required)
..... postalCode Σ 0..1 string Postal code for area
Example General: 9132
..... country Σ 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"}
.... 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 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..1 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
.... other Σ 1..1 Reference(NG RelatedPerson) This link provides reference to the client's related persons
.... type Σ 1..1 code The type of Link (eg. reference) client's related persons
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.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Patient.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:NationalIDNo.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:MedicalRecordsNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:BirthCertificateNo.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:PhoneNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:InsuranceNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.gender Base required NG Gender or Sex VS 📦0.1.0 This IG
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address.district Base required NG LGAs VS 📦0.1.0 This IG
Patient.address.state Base required NG States VS 📦0.1.0 This IG
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.relationship.​text Base extensible NG Relationships VS 📦0.1.0 This IG
Patient.contact.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.contact.address.​type Base required AddressType 📍4.0.1 FHIR Std.
Patient.contact.address.​district Base required NG LGAs VS 📦0.1.0 This IG
Patient.contact.address.​state Base required NG States VS 📦0.1.0 This IG
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
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: 4 elements(11 nested mandatory elements)
Must-Support: 15 elements
Prohibited: 15 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron