NPHCDA Immunization FHIR IG
0.9.0 - ci-build Nigeria flag

NPHCDA Immunization FHIR IG, published by https://nphcda.gov.ng. This guide is not an authorized publication; it is the continuous build for version 0.9.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/NPHCDA-ImmunizationIG/ and changes regularly. See the Directory of published versions

Resource Profile: NG-Imm Patient

Official URL: https://nphcda.gov.ng/ig/StructureDefinition/NgImmPatient Version: 0.9.0
Draft as of 2026-10-07 Computable Name: NgImmPatient

Nigeria Immunization 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: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.meta.lastUpdated This element must be supported. This element is included in summaries. 1..1 instant The date and time when the client record was created or last updated.
Patient.Slices for identifier This element must be supported. This element is included in summaries. 1..* Identifier The identifier set given to a Client at different points (can be the National ID, the Hospital specific mrn, or even phone number)
Slice: Unordered, Open by value:type.coding.code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:All Slices Content/Rules for all slices
Patient.Slices for identifier.identifier:NationalIDNo This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:NationalIDNo.system This element is included in summaries. 0..1 uri NIMC's identifier in the system validated at https://nimc.org/nin
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:NationalIDNo.value This element is included in summaries. 1..1 string The NIN number of the client which is a unique 11 digit number
Example General: 123456
Patient.Slices for identifier.identifier:MedicalRecordsNumber This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:MedicalRecordsNumber.system This element is included in summaries. 0..1 uri The institution issuing the MRN number (e.g., Asokoro Hospital)
Example General: http://www.acme.com/identifiers/patient
Example Example MRN system validated at http://asokoro.org/medicalrecord-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:MedicalRecordsNumber.value This element is included in summaries. 1..1 string The specific medical number value given the client at a health institution
Example General: 123456
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.system This element is included in summaries. 0..1 uri The institution generating the immunization number (e.g., NPHCDA)
Example General: http://www.acme.com/identifiers/patient
Example Example Immunization number system validated at https://nphcda.gov.ng/immunization-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.value This element is included in summaries. 1..1 string The client immunization number generated where applicable
Example General: 123456
Patient.Slices for identifier.identifier:BirthCertificateNo This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:BirthCertificateNo.system This element is included in summaries. 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 validated at http://npc.gov.ng/birthCertificate-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:BirthCertificateNo.value This element is included in summaries. 1..1 string The client's birth certificate number
Example General: 123456
Patient.Slices for identifier.identifier:PhoneNumber This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PhoneNumber.system This element is included in summaries. 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 validated at http://mtnonline.com/phone-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:PhoneNumber.value This element is included in summaries. 1..1 string client's phone number which is 11 digits
Example General: 123456
Patient.Slices for identifier.identifier:InsuranceNumber This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:InsuranceNumber.system This element is included in summaries. 0..1 uri The generating institution e.g., State, NHIA, or HMO
Example General: http://www.acme.com/identifiers/patient
Example Example Insurance system validated at http://nhia.gov.ng/insurance-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:InsuranceNumber.value This element is included in summaries. 1..1 string The actual insurance number generated at state, national or hmo authorities
Example General: 123456
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Indicates Whether this patient's record is in active use or not (eg. for Immunization, this flag can be set to true between 0-24 months, and false there after, to optimize searches)
Patient.name This element must be supported. This element is included in summaries. 1..1 HumanName A name associated with the patient
Patient.name.family This element is included in summaries. 1..1 string The surname or family name of the Immunization client
Patient.name.given This element is included in summaries. 1..* string The other names of the Immunization client like the Firstname and Middle names if applicable
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.gender This element is included in summaries. 0..1 code The sex of the Immunization client
Binding: NG Gender or Sex VS (required)
Patient.birthDate This element must be supported. This element is included in summaries. 0..1 date The date of birth of the Immunization client in the form dd-mm-yyy
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element must be supported. This element is included in summaries. 0..* Address An address for the individual
Patient.address.Slices for extension Content/Rules for all slices
Patient.address.Slices for extension.extension:administrativeWard This element must be supported. 0..1 CodeableConcept NG-Imm Administrative Wards
URL: https://nphcda.gov.ng/ig/StructureDefinition/nigeria-administrative-ward
Binding: NG-Imm Wards VS (example)
Patient.address.line This element is included in summaries. 0..1 string The house number number, stree, 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
Patient.address.city This element is included in summaries. 0..1 string The city, village, town or settlement where the client lives in the state
Example General: Erewhon
Patient.address.district This element is included in summaries. 0..1 string The FHIR name is district, used as Nigeria LGA in this profile
Binding: NG-Imm LGAs VS (required)
Example General: Madison
Patient.address.state This element is included in summaries. 0..1 string The name of the state where the client resides in Nigeria
Binding: NG-Imm States VS (required)
Patient.contact This element must be supported. C 0..* BackboneElement The contact information of the Client's primary Caregiver, can be a Parent or Guardian
Constraints: pat-1
Patient.contact.telecom This element must be supported. 0..* ContactPoint A contact detail for the person
Patient.contact.telecom.system This element is included in summaries. C 0..1 code The primary means to contact the Client's primary Caregiver or Guardian
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.contact.telecom.value This element is included in summaries. 0..1 string The primary means to value(phone no. or email address) the Client's primary Caregiver or Guardian
Patient.contact.address 0..1 Address Address for the contact person
Patient.contact.address.Slices for extension Content/Rules for all slices
Patient.contact.address.Slices for extension.extension:administrativeWard This element must be supported. 0..1 CodeableConcept NG-Imm Administrative Wards
URL: https://nphcda.gov.ng/ig/StructureDefinition/nigeria-administrative-ward
Binding: NG-Imm Wards VS (example)
Patient.contact.address.line This element must be supported. This element is included in summaries. 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
Patient.contact.address.city This element is included in summaries. 0..1 string The city, town or settlement where the Client's primary Caregiver or Guardian lives
Example General: Erewhon
Patient.contact.address.district This element is included in summaries. 0..1 string The LGA where the Client's primary Caregiver or Guardian lives
Binding: NG-Imm LGAs VS (required)
Example General: Madison
Patient.contact.address.state This element is included in summaries. 0..1 string The State in Nigeria where the Client's primary Caregiver or Guardian lives
Binding: NG-Imm States VS (required)
Patient.link This element is a modifier element. This element is included in summaries. 0..1 BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.other This element is included in summaries. 1..1 Reference(NG-Imm RelatedPerson) This link provides reference to the immunization client's Related persons
Patient.link.type This element is included in summaries. 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.9.0 This IG
Patient.address.district Base required NG-Imm LGAs VS 📦0.9.0 This IG
Patient.address.state Base required NG-Imm States VS 📦0.9.0 This IG
Patient.contact.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.contact.address.​district Base required NG-Imm LGAs VS 📦0.9.0 This IG
Patient.contact.address.​state Base required NG-Imm States VS 📦0.9.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: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.meta
Patient.meta.lastUpdated This element must be supported. 1..1 instant The date and time when the client record was created or last updated.
Patient.implicitRules 0..0 A set of rules under which this content was created
Patient.modifierExtension 0..0 Extension
Patient.Slices for identifier.identifier:All Slices Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.use 0..0 usual | official | temp | secondary | old (If known)
Patient.Slices for identifier.identifier:NationalIDNo This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:NationalIDNo.use 0..0 usual | official | temp | secondary | old (If known)
Patient.Slices for identifier.identifier:NationalIDNo.type
Patient.Slices for identifier.identifier:NationalIDNo.type.coding
Patient.Slices for identifier.identifier:NationalIDNo.type.coding.system 0..1 uri Identity of the terminology system
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:NationalIDNo.type.coding.code 1..1 code Symbol in syntax defined by the system
Required Pattern: NIN
Patient.Slices for identifier.identifier:NationalIDNo.type.coding.display 0..1 string Representation defined by the system
Required Pattern: National Identity Number of Client or Caregiver
Patient.Slices for identifier.identifier:NationalIDNo.system 0..1 uri NIMC's identifier in the system validated at https://nimc.org/nin
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:NationalIDNo.value 1..1 string The NIN number of the client which is a unique 11 digit number
Patient.Slices for identifier.identifier:MedicalRecordsNumber This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:MedicalRecordsNumber.use 0..0 usual | official | temp | secondary | old (If known)
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.coding
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.coding.system 0..1 uri Identity of the terminology system
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.coding.code 1..1 code Symbol in syntax defined by the system
Required Pattern: MRN
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.coding.display 0..1 string Representation defined by the system
Required Pattern: Medical Record Number
Patient.Slices for identifier.identifier:MedicalRecordsNumber.system 0..1 uri The institution issuing the MRN number (e.g., Asokoro Hospital)
Example Example MRN system validated at http://asokoro.org/medicalrecord-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:MedicalRecordsNumber.value 1..1 string The specific medical number value given the client at a health institution
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.use 0..0 usual | official | temp | secondary | old (If known)
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.coding
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.coding.system 0..1 uri Identity of the terminology system
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.coding.code 1..1 code Symbol in syntax defined by the system
Required Pattern: IMMNO
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.coding.display 0..1 string Representation defined by the system
Required Pattern: Immunization Record Number
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.system 0..1 uri The institution generating the immunization number (e.g., NPHCDA)
Example Example Immunization number system validated at https://nphcda.gov.ng/immunization-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.value 1..1 string The client immunization number generated where applicable
Patient.Slices for identifier.identifier:BirthCertificateNo This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:BirthCertificateNo.use 0..0 usual | official | temp | secondary | old (If known)
Patient.Slices for identifier.identifier:BirthCertificateNo.type
Patient.Slices for identifier.identifier:BirthCertificateNo.type.coding
Patient.Slices for identifier.identifier:BirthCertificateNo.type.coding.system 0..1 uri Identity of the terminology system
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:BirthCertificateNo.type.coding.code 1..1 code Symbol in syntax defined by the system
Required Pattern: BIRTHCERT
Patient.Slices for identifier.identifier:BirthCertificateNo.type.coding.display 0..1 string Representation defined by the system
Required Pattern: Birth Certificate Number
Patient.Slices for identifier.identifier:BirthCertificateNo.system 0..1 uri The institution generating the birth certificate number (e.g., NPC)
Example Example Birth Certificate number system validated at http://npc.gov.ng/birthCertificate-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:BirthCertificateNo.value 1..1 string The client's birth certificate number
Patient.Slices for identifier.identifier:PhoneNumber This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PhoneNumber.use 0..0 usual | official | temp | secondary | old (If known)
Patient.Slices for identifier.identifier:PhoneNumber.type
Patient.Slices for identifier.identifier:PhoneNumber.type.coding
Patient.Slices for identifier.identifier:PhoneNumber.type.coding.system 0..1 uri Identity of the terminology system
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:PhoneNumber.type.coding.code 1..1 code Symbol in syntax defined by the system
Required Pattern: MOBILE
Patient.Slices for identifier.identifier:PhoneNumber.type.coding.display 0..1 string Representation defined by the system
Required Pattern: Primary Mobile Phone Number of the Client or CareGiver
Patient.Slices for identifier.identifier:PhoneNumber.system 0..1 uri The provider of the phone number (e.g., MTN)
Example Example Phone Number system validated at http://mtnonline.com/phone-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:PhoneNumber.value 1..1 string client's phone number which is 11 digits
Patient.Slices for identifier.identifier:InsuranceNumber This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:InsuranceNumber.use 0..0 usual | official | temp | secondary | old (If known)
Patient.Slices for identifier.identifier:InsuranceNumber.type
Patient.Slices for identifier.identifier:InsuranceNumber.type.coding
Patient.Slices for identifier.identifier:InsuranceNumber.type.coding.system 0..1 uri Identity of the terminology system
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:InsuranceNumber.type.coding.code 1..1 code Symbol in syntax defined by the system
Required Pattern: INSUR
Patient.Slices for identifier.identifier:InsuranceNumber.type.coding.display 0..1 string Representation defined by the system
Required Pattern: The Insurance or HMO number of the client
Patient.Slices for identifier.identifier:InsuranceNumber.system 0..1 uri The generating institution e.g., State, NHIA, or HMO
Example Example Insurance system validated at http://nhia.gov.ng/insurance-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:InsuranceNumber.value 1..1 string The actual insurance number generated at state, national or hmo authorities
Patient.active 0..1 boolean Indicates Whether this patient's record is in active use or not (eg. for Immunization, this flag can be set to true between 0-24 months, and false there after, to optimize searches)
Patient.name This element must be supported. 1..1 HumanName A name associated with the patient
Patient.name.use 0..0 usual | official | temp | nickname | anonymous | old | maiden
Patient.name.family 1..1 string The surname or family name of the Immunization client
Patient.name.given 1..* string The other names of the Immunization client like the Firstname and Middle names if applicable
Patient.gender 0..1 code The sex of the Immunization client
Binding: NG Gender or Sex VS (required)
Patient.birthDate This element must be supported. 0..1 date The date of birth of the Immunization client in the form dd-mm-yyy
Patient.address This element must be supported. 0..* Address An address for the individual
Patient.address.Slices for extension Content/Rules for all slices
Patient.address.Slices for extension.extension:administrativeWard This element must be supported. 0..1 CodeableConcept NG-Imm Administrative Wards
URL: https://nphcda.gov.ng/ig/StructureDefinition/nigeria-administrative-ward
Binding: NG-Imm Wards VS (example)
Patient.address.use 0..0 home | work | temp | old | billing - purpose of this address
Patient.address.line 0..1 string The house number number, stree, and name where the Client lives
Patient.address.city 0..1 string The city, village, town or settlement where the client lives in the state
Patient.address.district 0..1 string The FHIR name is district, used as Nigeria LGA in this profile
Binding: NG-Imm LGAs VS (required)
Patient.address.state 0..1 string The name of the state where the client resides in Nigeria
Binding: NG-Imm States VS (required)
Patient.contact This element must be supported. 0..* BackboneElement The contact information of the Client's primary Caregiver, can be a Parent or Guardian
Patient.contact.modifierExtension 0..0 Extension
Patient.contact.relationship
Patient.contact.relationship.text 0..1 string The relationship of the Client with the primary Caregiver or Guardian (eg. Parent)
Binding: NG-Imm Relationships VS (extensible)
Patient.contact.name
Patient.contact.name.use 0..0 usual | official | temp | nickname | anonymous | old | maiden
Patient.contact.name.family 0..1 string The surname (family) name of the Client's primary Caregiver, can be a Parent or Guardian
Patient.contact.name.given 0..* string The first name of the Client's primary Caregiver, can be a Parent or Guardian
Patient.contact.telecom This element must be supported. 0..* ContactPoint A contact detail for the person
Patient.contact.telecom.system 0..1 code The primary means to contact the Client's primary Caregiver or Guardian
Patient.contact.telecom.value 0..1 string The primary means to value(phone no. or email address) the Client's primary Caregiver or Guardian
Patient.contact.telecom.use 0..0 home | work | temp | old | mobile - purpose of this contact point
Patient.contact.address
Patient.contact.address.Slices for extension Content/Rules for all slices
Patient.contact.address.Slices for extension.extension:administrativeWard This element must be supported. 0..1 CodeableConcept NG-Imm Administrative Wards
URL: https://nphcda.gov.ng/ig/StructureDefinition/nigeria-administrative-ward
Binding: NG-Imm Wards VS (example)
Patient.contact.address.use 0..0 home | work | temp | old | billing - purpose of this address
Patient.contact.address.line This element must be supported. 0..1 string The line address of the Client's primary Caregiver or Guardian
Patient.contact.address.city 0..1 string The city, town or settlement where the Client's primary Caregiver or Guardian lives
Patient.contact.address.district 0..1 string The LGA where the Client's primary Caregiver or Guardian lives
Binding: NG-Imm LGAs VS (required)
Patient.contact.address.state 0..1 string The State in Nigeria where the Client's primary Caregiver or Guardian lives
Binding: NG-Imm States VS (required)
Patient.link 0..1 BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension 0..0 Extension
Patient.link.other 1..1 Reference(NG-Imm RelatedPerson) This link provides reference to the immunization client's Related persons
Patient.link.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.9.0 This IG
Patient.address.district Base required NG-Imm LGAs VS 📦0.9.0 This IG
Patient.address.state Base required NG-Imm States VS 📦0.9.0 This IG
Patient.contact.relationship.​text Base extensible NG-Imm Relationships VS 📦0.9.0 This IG
Patient.contact.address.​district Base required NG-Imm LGAs VS 📦0.9.0 This IG
Patient.contact.address.​state Base required NG-Imm States VS 📦0.9.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.meta.id 0..1 string Unique id for inter-element referencing
Patient.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Patient.meta.lastUpdated This element must be supported. This element is included in summaries. 1..1 instant The date and time when the client record was created or last updated.
Patient.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Patient.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Patient.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Patient.meta.tag This element is included in summaries. 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".
Patient.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Patient.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
Patient.contained 0..* Resource Contained, inline Resources
Patient.extension 0..* Extension Additional content defined by implementations
Patient.Slices for identifier This element must be supported. This element is included in summaries. 1..* Identifier The identifier set given to a Client at different points (can be the National ID, the Hospital specific mrn, or even phone number)
Slice: Unordered, Open by value:type.coding.code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:All Slices Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:All Slices.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:All Slices.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:All Slices.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:All Slices.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:All Slices.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:NationalIDNo This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:NationalIDNo.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:NationalIDNo.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:NationalIDNo.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:NationalIDNo.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:NationalIDNo.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:NationalIDNo.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Patient.Slices for identifier.identifier:NationalIDNo.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:NationalIDNo.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:NationalIDNo.type.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:NationalIDNo.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:NationalIDNo.type.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Required Pattern: NIN
Patient.Slices for identifier.identifier:NationalIDNo.type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Required Pattern: National Identity Number of Client or Caregiver
Patient.Slices for identifier.identifier:NationalIDNo.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:NationalIDNo.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:NationalIDNo.system This element is included in summaries. 0..1 uri NIMC's identifier in the system validated at https://nimc.org/nin
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:NationalIDNo.value This element is included in summaries. 1..1 string The NIN number of the client which is a unique 11 digit number
Example General: 123456
Patient.Slices for identifier.identifier:NationalIDNo.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:NationalIDNo.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:MedicalRecordsNumber This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:MedicalRecordsNumber.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:MedicalRecordsNumber.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Required Pattern: MRN
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Required Pattern: Medical Record Number
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:MedicalRecordsNumber.system This element is included in summaries. 0..1 uri The institution issuing the MRN number (e.g., Asokoro Hospital)
Example General: http://www.acme.com/identifiers/patient
Example Example MRN system validated at http://asokoro.org/medicalrecord-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:MedicalRecordsNumber.value This element is included in summaries. 1..1 string The specific medical number value given the client at a health institution
Example General: 123456
Patient.Slices for identifier.identifier:MedicalRecordsNumber.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:MedicalRecordsNumber.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Required Pattern: IMMNO
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Required Pattern: Immunization Record Number
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.system This element is included in summaries. 0..1 uri The institution generating the immunization number (e.g., NPHCDA)
Example General: http://www.acme.com/identifiers/patient
Example Example Immunization number system validated at https://nphcda.gov.ng/immunization-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.value This element is included in summaries. 1..1 string The client immunization number generated where applicable
Example General: 123456
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:BirthCertificateNo This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:BirthCertificateNo.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:BirthCertificateNo.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:BirthCertificateNo.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:BirthCertificateNo.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:BirthCertificateNo.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:BirthCertificateNo.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Patient.Slices for identifier.identifier:BirthCertificateNo.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:BirthCertificateNo.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:BirthCertificateNo.type.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:BirthCertificateNo.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:BirthCertificateNo.type.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Required Pattern: BIRTHCERT
Patient.Slices for identifier.identifier:BirthCertificateNo.type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Required Pattern: Birth Certificate Number
Patient.Slices for identifier.identifier:BirthCertificateNo.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:BirthCertificateNo.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:BirthCertificateNo.system This element is included in summaries. 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 validated at http://npc.gov.ng/birthCertificate-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:BirthCertificateNo.value This element is included in summaries. 1..1 string The client's birth certificate number
Example General: 123456
Patient.Slices for identifier.identifier:BirthCertificateNo.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:BirthCertificateNo.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:PhoneNumber This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PhoneNumber.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PhoneNumber.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:PhoneNumber.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:PhoneNumber.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PhoneNumber.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:PhoneNumber.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Patient.Slices for identifier.identifier:PhoneNumber.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PhoneNumber.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:PhoneNumber.type.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:PhoneNumber.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:PhoneNumber.type.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Required Pattern: MOBILE
Patient.Slices for identifier.identifier:PhoneNumber.type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Required Pattern: Primary Mobile Phone Number of the Client or CareGiver
Patient.Slices for identifier.identifier:PhoneNumber.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:PhoneNumber.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:PhoneNumber.system This element is included in summaries. 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 validated at http://mtnonline.com/phone-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:PhoneNumber.value This element is included in summaries. 1..1 string client's phone number which is 11 digits
Example General: 123456
Patient.Slices for identifier.identifier:PhoneNumber.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:PhoneNumber.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:InsuranceNumber This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:InsuranceNumber.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:InsuranceNumber.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:InsuranceNumber.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:InsuranceNumber.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:InsuranceNumber.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:InsuranceNumber.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Patient.Slices for identifier.identifier:InsuranceNumber.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:InsuranceNumber.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:InsuranceNumber.type.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:InsuranceNumber.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:InsuranceNumber.type.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Required Pattern: INSUR
Patient.Slices for identifier.identifier:InsuranceNumber.type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Required Pattern: The Insurance or HMO number of the client
Patient.Slices for identifier.identifier:InsuranceNumber.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:InsuranceNumber.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:InsuranceNumber.system This element is included in summaries. 0..1 uri The generating institution e.g., State, NHIA, or HMO
Example General: http://www.acme.com/identifiers/patient
Example Example Insurance system validated at http://nhia.gov.ng/insurance-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:InsuranceNumber.value This element is included in summaries. 1..1 string The actual insurance number generated at state, national or hmo authorities
Example General: 123456
Patient.Slices for identifier.identifier:InsuranceNumber.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:InsuranceNumber.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Indicates Whether this patient's record is in active use or not (eg. for Immunization, this flag can be set to true between 0-24 months, and false there after, to optimize searches)
Patient.name This element must be supported. This element is included in summaries. 1..1 HumanName A name associated with the patient
Patient.name.id 0..1 string Unique id for inter-element referencing
Patient.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.name.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.name.family This element is included in summaries. 1..1 string The surname or family name of the Immunization client
Patient.name.given This element is included in summaries. 1..* string The other names of the Immunization client like the Firstname and Middle names if applicable
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Patient.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Patient.gender This element is included in summaries. 0..1 code The sex of the Immunization client
Binding: NG Gender or Sex VS (required)
Patient.birthDate This element must be supported. This element is included in summaries. 0..1 date The date of birth of the Immunization client in the form dd-mm-yyy
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element must be supported. This element is included in summaries. 0..* Address An address for the individual
Patient.address.id 0..1 string Unique id for inter-element referencing
Patient.address.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.address.Slices for extension.extension:administrativeWard This element must be supported. 0..1 CodeableConcept NG-Imm Administrative Wards
URL: https://nphcda.gov.ng/ig/StructureDefinition/nigeria-administrative-ward
Binding: NG-Imm Wards VS (example)
Patient.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Patient.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Patient.address.line This element is included in summaries. 0..1 string The house number number, stree, 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
Patient.address.city This element is included in summaries. 0..1 string The city, village, town or settlement where the client lives in the state
Example General: Erewhon
Patient.address.district This element is included in summaries. 0..1 string The FHIR name is district, used as Nigeria LGA in this profile
Binding: NG-Imm LGAs VS (required)
Example General: Madison
Patient.address.state This element is included in summaries. 0..1 string The name of the state where the client resides in Nigeria
Binding: NG-Imm States VS (required)
Patient.address.postalCode This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
Patient.address.country This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Patient.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x] 0..1 Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean boolean
Patient.multipleBirth[x].multipleBirthInteger integer
Patient.photo 0..* Attachment Image of the patient
Patient.contact This element must be supported. C 0..* BackboneElement The contact information of the Client's primary Caregiver, can be a Parent or Guardian
Constraints: pat-1
Patient.contact.id 0..1 string Unique id for inter-element referencing
Patient.contact.extension 0..* Extension Additional content defined by implementations
Patient.contact.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.
Patient.contact.relationship.id 0..1 string Unique id for inter-element referencing
Patient.contact.relationship.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.contact.relationship.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Patient.contact.relationship.text This element is included in summaries. 0..1 string The relationship of the Client with the primary Caregiver or Guardian (eg. Parent)
Binding: NG-Imm Relationships VS (extensible)
Patient.contact.name 0..1 HumanName A name associated with the contact person
Patient.contact.name.id 0..1 string Unique id for inter-element referencing
Patient.contact.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.contact.name.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.contact.name.family This element is included in summaries. 0..1 string The surname (family) name of the Client's primary Caregiver, can be a Parent or Guardian
Patient.contact.name.given This element is included in summaries. 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
Patient.contact.name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.contact.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.contact.name.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Patient.contact.telecom This element must be supported. 0..* ContactPoint A contact detail for the person
Patient.contact.telecom.id 0..1 string Unique id for inter-element referencing
Patient.contact.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.contact.telecom.system This element is included in summaries. C 0..1 code The primary means to contact the Client's primary Caregiver or Guardian
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.contact.telecom.value This element is included in summaries. 0..1 string The primary means to value(phone no. or email address) the Client's primary Caregiver or Guardian
Patient.contact.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Patient.contact.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Patient.contact.address 0..1 Address Address for the contact person
Patient.contact.address.id 0..1 string Unique id for inter-element referencing
Patient.contact.address.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.contact.address.Slices for extension.extension:administrativeWard This element must be supported. 0..1 CodeableConcept NG-Imm Administrative Wards
URL: https://nphcda.gov.ng/ig/StructureDefinition/nigeria-administrative-ward
Binding: NG-Imm Wards VS (example)
Patient.contact.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Patient.contact.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Patient.contact.address.line This element must be supported. This element is included in summaries. 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
Patient.contact.address.city This element is included in summaries. 0..1 string The city, town or settlement where the Client's primary Caregiver or Guardian lives
Example General: Erewhon
Patient.contact.address.district This element is included in summaries. 0..1 string The LGA where the Client's primary Caregiver or Guardian lives
Binding: NG-Imm LGAs VS (required)
Example General: Madison
Patient.contact.address.state This element is included in summaries. 0..1 string The State in Nigeria where the Client's primary Caregiver or Guardian lives
Binding: NG-Imm States VS (required)
Patient.contact.address.postalCode This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
Patient.contact.address.country This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Patient.contact.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.contact.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.contact.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
Patient.communication.id 0..1 string Unique id for inter-element referencing
Patient.communication.extension 0..* Extension Additional content defined by implementations
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.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
Patient.communication.preferred 0..1 boolean Language preference indicator
Patient.generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization that is the custodian of the patient record
Patient.link This element is a modifier element. This element is included in summaries. 0..1 BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.id 0..1 string Unique id for inter-element referencing
Patient.link.extension 0..* Extension Additional content defined by implementations
Patient.link.other This element is included in summaries. 1..1 Reference(NG-Imm RelatedPerson) This link provides reference to the immunization client's Related persons
Patient.link.type This element is included in summaries. 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:ImmunizationRecordsNumber.​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.9.0 This IG
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address.district Base required NG-Imm LGAs VS 📦0.9.0 This IG
Patient.address.state Base required NG-Imm States VS 📦0.9.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-Imm Relationships VS 📦0.9.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-Imm LGAs VS 📦0.9.0 This IG
Patient.contact.address.​state Base required NG-Imm States VS 📦0.9.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(13 nested mandatory elements)
Must-Support: 16 elements
Prohibited: 16 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: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.meta.lastUpdated This element must be supported. This element is included in summaries. 1..1 instant The date and time when the client record was created or last updated.
Patient.Slices for identifier This element must be supported. This element is included in summaries. 1..* Identifier The identifier set given to a Client at different points (can be the National ID, the Hospital specific mrn, or even phone number)
Slice: Unordered, Open by value:type.coding.code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:All Slices Content/Rules for all slices
Patient.Slices for identifier.identifier:NationalIDNo This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:NationalIDNo.system This element is included in summaries. 0..1 uri NIMC's identifier in the system validated at https://nimc.org/nin
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:NationalIDNo.value This element is included in summaries. 1..1 string The NIN number of the client which is a unique 11 digit number
Example General: 123456
Patient.Slices for identifier.identifier:MedicalRecordsNumber This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:MedicalRecordsNumber.system This element is included in summaries. 0..1 uri The institution issuing the MRN number (e.g., Asokoro Hospital)
Example General: http://www.acme.com/identifiers/patient
Example Example MRN system validated at http://asokoro.org/medicalrecord-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:MedicalRecordsNumber.value This element is included in summaries. 1..1 string The specific medical number value given the client at a health institution
Example General: 123456
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.system This element is included in summaries. 0..1 uri The institution generating the immunization number (e.g., NPHCDA)
Example General: http://www.acme.com/identifiers/patient
Example Example Immunization number system validated at https://nphcda.gov.ng/immunization-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.value This element is included in summaries. 1..1 string The client immunization number generated where applicable
Example General: 123456
Patient.Slices for identifier.identifier:BirthCertificateNo This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:BirthCertificateNo.system This element is included in summaries. 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 validated at http://npc.gov.ng/birthCertificate-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:BirthCertificateNo.value This element is included in summaries. 1..1 string The client's birth certificate number
Example General: 123456
Patient.Slices for identifier.identifier:PhoneNumber This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PhoneNumber.system This element is included in summaries. 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 validated at http://mtnonline.com/phone-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:PhoneNumber.value This element is included in summaries. 1..1 string client's phone number which is 11 digits
Example General: 123456
Patient.Slices for identifier.identifier:InsuranceNumber This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:InsuranceNumber.system This element is included in summaries. 0..1 uri The generating institution e.g., State, NHIA, or HMO
Example General: http://www.acme.com/identifiers/patient
Example Example Insurance system validated at http://nhia.gov.ng/insurance-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:InsuranceNumber.value This element is included in summaries. 1..1 string The actual insurance number generated at state, national or hmo authorities
Example General: 123456
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Indicates Whether this patient's record is in active use or not (eg. for Immunization, this flag can be set to true between 0-24 months, and false there after, to optimize searches)
Patient.name This element must be supported. This element is included in summaries. 1..1 HumanName A name associated with the patient
Patient.name.family This element is included in summaries. 1..1 string The surname or family name of the Immunization client
Patient.name.given This element is included in summaries. 1..* string The other names of the Immunization client like the Firstname and Middle names if applicable
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.gender This element is included in summaries. 0..1 code The sex of the Immunization client
Binding: NG Gender or Sex VS (required)
Patient.birthDate This element must be supported. This element is included in summaries. 0..1 date The date of birth of the Immunization client in the form dd-mm-yyy
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element must be supported. This element is included in summaries. 0..* Address An address for the individual
Patient.address.Slices for extension Content/Rules for all slices
Patient.address.Slices for extension.extension:administrativeWard This element must be supported. 0..1 CodeableConcept NG-Imm Administrative Wards
URL: https://nphcda.gov.ng/ig/StructureDefinition/nigeria-administrative-ward
Binding: NG-Imm Wards VS (example)
Patient.address.line This element is included in summaries. 0..1 string The house number number, stree, 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
Patient.address.city This element is included in summaries. 0..1 string The city, village, town or settlement where the client lives in the state
Example General: Erewhon
Patient.address.district This element is included in summaries. 0..1 string The FHIR name is district, used as Nigeria LGA in this profile
Binding: NG-Imm LGAs VS (required)
Example General: Madison
Patient.address.state This element is included in summaries. 0..1 string The name of the state where the client resides in Nigeria
Binding: NG-Imm States VS (required)
Patient.contact This element must be supported. C 0..* BackboneElement The contact information of the Client's primary Caregiver, can be a Parent or Guardian
Constraints: pat-1
Patient.contact.telecom This element must be supported. 0..* ContactPoint A contact detail for the person
Patient.contact.telecom.system This element is included in summaries. C 0..1 code The primary means to contact the Client's primary Caregiver or Guardian
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.contact.telecom.value This element is included in summaries. 0..1 string The primary means to value(phone no. or email address) the Client's primary Caregiver or Guardian
Patient.contact.address 0..1 Address Address for the contact person
Patient.contact.address.Slices for extension Content/Rules for all slices
Patient.contact.address.Slices for extension.extension:administrativeWard This element must be supported. 0..1 CodeableConcept NG-Imm Administrative Wards
URL: https://nphcda.gov.ng/ig/StructureDefinition/nigeria-administrative-ward
Binding: NG-Imm Wards VS (example)
Patient.contact.address.line This element must be supported. This element is included in summaries. 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
Patient.contact.address.city This element is included in summaries. 0..1 string The city, town or settlement where the Client's primary Caregiver or Guardian lives
Example General: Erewhon
Patient.contact.address.district This element is included in summaries. 0..1 string The LGA where the Client's primary Caregiver or Guardian lives
Binding: NG-Imm LGAs VS (required)
Example General: Madison
Patient.contact.address.state This element is included in summaries. 0..1 string The State in Nigeria where the Client's primary Caregiver or Guardian lives
Binding: NG-Imm States VS (required)
Patient.link This element is a modifier element. This element is included in summaries. 0..1 BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.other This element is included in summaries. 1..1 Reference(NG-Imm RelatedPerson) This link provides reference to the immunization client's Related persons
Patient.link.type This element is included in summaries. 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.9.0 This IG
Patient.address.district Base required NG-Imm LGAs VS 📦0.9.0 This IG
Patient.address.state Base required NG-Imm States VS 📦0.9.0 This IG
Patient.contact.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.contact.address.​district Base required NG-Imm LGAs VS 📦0.9.0 This IG
Patient.contact.address.​state Base required NG-Imm States VS 📦0.9.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: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.meta
Patient.meta.lastUpdated This element must be supported. 1..1 instant The date and time when the client record was created or last updated.
Patient.implicitRules 0..0 A set of rules under which this content was created
Patient.modifierExtension 0..0 Extension
Patient.Slices for identifier This element must be supported. 1..* Identifier The identifier set given to a Client at different points (can be the National ID, the Hospital specific mrn, or even phone number)
Slice: Unordered, Open by value:type.coding.code
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:All Slices Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.use 0..0 usual | official | temp | secondary | old (If known)
Patient.Slices for identifier.identifier:NationalIDNo This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:NationalIDNo.use 0..0 usual | official | temp | secondary | old (If known)
Patient.Slices for identifier.identifier:NationalIDNo.type
Patient.Slices for identifier.identifier:NationalIDNo.type.coding
Patient.Slices for identifier.identifier:NationalIDNo.type.coding.system 0..1 uri Identity of the terminology system
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:NationalIDNo.type.coding.code 1..1 code Symbol in syntax defined by the system
Required Pattern: NIN
Patient.Slices for identifier.identifier:NationalIDNo.type.coding.display 0..1 string Representation defined by the system
Required Pattern: National Identity Number of Client or Caregiver
Patient.Slices for identifier.identifier:NationalIDNo.system 0..1 uri NIMC's identifier in the system validated at https://nimc.org/nin
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:NationalIDNo.value 1..1 string The NIN number of the client which is a unique 11 digit number
Patient.Slices for identifier.identifier:MedicalRecordsNumber This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:MedicalRecordsNumber.use 0..0 usual | official | temp | secondary | old (If known)
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.coding
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.coding.system 0..1 uri Identity of the terminology system
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.coding.code 1..1 code Symbol in syntax defined by the system
Required Pattern: MRN
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.coding.display 0..1 string Representation defined by the system
Required Pattern: Medical Record Number
Patient.Slices for identifier.identifier:MedicalRecordsNumber.system 0..1 uri The institution issuing the MRN number (e.g., Asokoro Hospital)
Example Example MRN system validated at http://asokoro.org/medicalrecord-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:MedicalRecordsNumber.value 1..1 string The specific medical number value given the client at a health institution
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.use 0..0 usual | official | temp | secondary | old (If known)
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.coding
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.coding.system 0..1 uri Identity of the terminology system
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.coding.code 1..1 code Symbol in syntax defined by the system
Required Pattern: IMMNO
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.coding.display 0..1 string Representation defined by the system
Required Pattern: Immunization Record Number
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.system 0..1 uri The institution generating the immunization number (e.g., NPHCDA)
Example Example Immunization number system validated at https://nphcda.gov.ng/immunization-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.value 1..1 string The client immunization number generated where applicable
Patient.Slices for identifier.identifier:BirthCertificateNo This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:BirthCertificateNo.use 0..0 usual | official | temp | secondary | old (If known)
Patient.Slices for identifier.identifier:BirthCertificateNo.type
Patient.Slices for identifier.identifier:BirthCertificateNo.type.coding
Patient.Slices for identifier.identifier:BirthCertificateNo.type.coding.system 0..1 uri Identity of the terminology system
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:BirthCertificateNo.type.coding.code 1..1 code Symbol in syntax defined by the system
Required Pattern: BIRTHCERT
Patient.Slices for identifier.identifier:BirthCertificateNo.type.coding.display 0..1 string Representation defined by the system
Required Pattern: Birth Certificate Number
Patient.Slices for identifier.identifier:BirthCertificateNo.system 0..1 uri The institution generating the birth certificate number (e.g., NPC)
Example Example Birth Certificate number system validated at http://npc.gov.ng/birthCertificate-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:BirthCertificateNo.value 1..1 string The client's birth certificate number
Patient.Slices for identifier.identifier:PhoneNumber This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PhoneNumber.use 0..0 usual | official | temp | secondary | old (If known)
Patient.Slices for identifier.identifier:PhoneNumber.type
Patient.Slices for identifier.identifier:PhoneNumber.type.coding
Patient.Slices for identifier.identifier:PhoneNumber.type.coding.system 0..1 uri Identity of the terminology system
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:PhoneNumber.type.coding.code 1..1 code Symbol in syntax defined by the system
Required Pattern: MOBILE
Patient.Slices for identifier.identifier:PhoneNumber.type.coding.display 0..1 string Representation defined by the system
Required Pattern: Primary Mobile Phone Number of the Client or CareGiver
Patient.Slices for identifier.identifier:PhoneNumber.system 0..1 uri The provider of the phone number (e.g., MTN)
Example Example Phone Number system validated at http://mtnonline.com/phone-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:PhoneNumber.value 1..1 string client's phone number which is 11 digits
Patient.Slices for identifier.identifier:InsuranceNumber This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:InsuranceNumber.use 0..0 usual | official | temp | secondary | old (If known)
Patient.Slices for identifier.identifier:InsuranceNumber.type
Patient.Slices for identifier.identifier:InsuranceNumber.type.coding
Patient.Slices for identifier.identifier:InsuranceNumber.type.coding.system 0..1 uri Identity of the terminology system
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:InsuranceNumber.type.coding.code 1..1 code Symbol in syntax defined by the system
Required Pattern: INSUR
Patient.Slices for identifier.identifier:InsuranceNumber.type.coding.display 0..1 string Representation defined by the system
Required Pattern: The Insurance or HMO number of the client
Patient.Slices for identifier.identifier:InsuranceNumber.system 0..1 uri The generating institution e.g., State, NHIA, or HMO
Example Example Insurance system validated at http://nhia.gov.ng/insurance-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:InsuranceNumber.value 1..1 string The actual insurance number generated at state, national or hmo authorities
Patient.active 0..1 boolean Indicates Whether this patient's record is in active use or not (eg. for Immunization, this flag can be set to true between 0-24 months, and false there after, to optimize searches)
Patient.name This element must be supported. 1..1 HumanName A name associated with the patient
Patient.name.use 0..0 usual | official | temp | nickname | anonymous | old | maiden
Patient.name.family 1..1 string The surname or family name of the Immunization client
Patient.name.given 1..* string The other names of the Immunization client like the Firstname and Middle names if applicable
Patient.gender 0..1 code The sex of the Immunization client
Binding: NG Gender or Sex VS (required)
Patient.birthDate This element must be supported. 0..1 date The date of birth of the Immunization client in the form dd-mm-yyy
Patient.address This element must be supported. 0..* Address An address for the individual
Patient.address.Slices for extension Content/Rules for all slices
Patient.address.Slices for extension.extension:administrativeWard This element must be supported. 0..1 CodeableConcept NG-Imm Administrative Wards
URL: https://nphcda.gov.ng/ig/StructureDefinition/nigeria-administrative-ward
Binding: NG-Imm Wards VS (example)
Patient.address.use 0..0 home | work | temp | old | billing - purpose of this address
Patient.address.line 0..1 string The house number number, stree, and name where the Client lives
Patient.address.city 0..1 string The city, village, town or settlement where the client lives in the state
Patient.address.district 0..1 string The FHIR name is district, used as Nigeria LGA in this profile
Binding: NG-Imm LGAs VS (required)
Patient.address.state 0..1 string The name of the state where the client resides in Nigeria
Binding: NG-Imm States VS (required)
Patient.contact This element must be supported. 0..* BackboneElement The contact information of the Client's primary Caregiver, can be a Parent or Guardian
Patient.contact.modifierExtension 0..0 Extension
Patient.contact.relationship
Patient.contact.relationship.text 0..1 string The relationship of the Client with the primary Caregiver or Guardian (eg. Parent)
Binding: NG-Imm Relationships VS (extensible)
Patient.contact.name
Patient.contact.name.use 0..0 usual | official | temp | nickname | anonymous | old | maiden
Patient.contact.name.family 0..1 string The surname (family) name of the Client's primary Caregiver, can be a Parent or Guardian
Patient.contact.name.given 0..* string The first name of the Client's primary Caregiver, can be a Parent or Guardian
Patient.contact.telecom This element must be supported. 0..* ContactPoint A contact detail for the person
Patient.contact.telecom.system 0..1 code The primary means to contact the Client's primary Caregiver or Guardian
Patient.contact.telecom.value 0..1 string The primary means to value(phone no. or email address) the Client's primary Caregiver or Guardian
Patient.contact.telecom.use 0..0 home | work | temp | old | mobile - purpose of this contact point
Patient.contact.address
Patient.contact.address.Slices for extension Content/Rules for all slices
Patient.contact.address.Slices for extension.extension:administrativeWard This element must be supported. 0..1 CodeableConcept NG-Imm Administrative Wards
URL: https://nphcda.gov.ng/ig/StructureDefinition/nigeria-administrative-ward
Binding: NG-Imm Wards VS (example)
Patient.contact.address.use 0..0 home | work | temp | old | billing - purpose of this address
Patient.contact.address.line This element must be supported. 0..1 string The line address of the Client's primary Caregiver or Guardian
Patient.contact.address.city 0..1 string The city, town or settlement where the Client's primary Caregiver or Guardian lives
Patient.contact.address.district 0..1 string The LGA where the Client's primary Caregiver or Guardian lives
Binding: NG-Imm LGAs VS (required)
Patient.contact.address.state 0..1 string The State in Nigeria where the Client's primary Caregiver or Guardian lives
Binding: NG-Imm States VS (required)
Patient.link 0..1 BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension 0..0 Extension
Patient.link.other 1..1 Reference(NG-Imm RelatedPerson) This link provides reference to the immunization client's Related persons
Patient.link.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.9.0 This IG
Patient.address.district Base required NG-Imm LGAs VS 📦0.9.0 This IG
Patient.address.state Base required NG-Imm States VS 📦0.9.0 This IG
Patient.contact.relationship.​text Base extensible NG-Imm Relationships VS 📦0.9.0 This IG
Patient.contact.address.​district Base required NG-Imm LGAs VS 📦0.9.0 This IG
Patient.contact.address.​state Base required NG-Imm States VS 📦0.9.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.meta.id 0..1 string Unique id for inter-element referencing
Patient.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Patient.meta.lastUpdated This element must be supported. This element is included in summaries. 1..1 instant The date and time when the client record was created or last updated.
Patient.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Patient.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Patient.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Patient.meta.tag This element is included in summaries. 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".
Patient.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Patient.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
Patient.contained 0..* Resource Contained, inline Resources
Patient.extension 0..* Extension Additional content defined by implementations
Patient.Slices for identifier This element must be supported. This element is included in summaries. 1..* Identifier The identifier set given to a Client at different points (can be the National ID, the Hospital specific mrn, or even phone number)
Slice: Unordered, Open by value:type.coding.code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:All Slices Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:All Slices.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:All Slices.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:All Slices.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:All Slices.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:All Slices.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:NationalIDNo This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:NationalIDNo.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:NationalIDNo.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:NationalIDNo.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:NationalIDNo.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:NationalIDNo.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:NationalIDNo.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Patient.Slices for identifier.identifier:NationalIDNo.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:NationalIDNo.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:NationalIDNo.type.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:NationalIDNo.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:NationalIDNo.type.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Required Pattern: NIN
Patient.Slices for identifier.identifier:NationalIDNo.type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Required Pattern: National Identity Number of Client or Caregiver
Patient.Slices for identifier.identifier:NationalIDNo.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:NationalIDNo.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:NationalIDNo.system This element is included in summaries. 0..1 uri NIMC's identifier in the system validated at https://nimc.org/nin
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:NationalIDNo.value This element is included in summaries. 1..1 string The NIN number of the client which is a unique 11 digit number
Example General: 123456
Patient.Slices for identifier.identifier:NationalIDNo.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:NationalIDNo.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:MedicalRecordsNumber This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:MedicalRecordsNumber.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:MedicalRecordsNumber.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Required Pattern: MRN
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Required Pattern: Medical Record Number
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:MedicalRecordsNumber.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:MedicalRecordsNumber.system This element is included in summaries. 0..1 uri The institution issuing the MRN number (e.g., Asokoro Hospital)
Example General: http://www.acme.com/identifiers/patient
Example Example MRN system validated at http://asokoro.org/medicalrecord-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:MedicalRecordsNumber.value This element is included in summaries. 1..1 string The specific medical number value given the client at a health institution
Example General: 123456
Patient.Slices for identifier.identifier:MedicalRecordsNumber.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:MedicalRecordsNumber.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Required Pattern: IMMNO
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Required Pattern: Immunization Record Number
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.system This element is included in summaries. 0..1 uri The institution generating the immunization number (e.g., NPHCDA)
Example General: http://www.acme.com/identifiers/patient
Example Example Immunization number system validated at https://nphcda.gov.ng/immunization-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.value This element is included in summaries. 1..1 string The client immunization number generated where applicable
Example General: 123456
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:ImmunizationRecordsNumber.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:BirthCertificateNo This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:BirthCertificateNo.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:BirthCertificateNo.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:BirthCertificateNo.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:BirthCertificateNo.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:BirthCertificateNo.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:BirthCertificateNo.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Patient.Slices for identifier.identifier:BirthCertificateNo.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:BirthCertificateNo.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:BirthCertificateNo.type.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:BirthCertificateNo.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:BirthCertificateNo.type.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Required Pattern: BIRTHCERT
Patient.Slices for identifier.identifier:BirthCertificateNo.type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Required Pattern: Birth Certificate Number
Patient.Slices for identifier.identifier:BirthCertificateNo.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:BirthCertificateNo.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:BirthCertificateNo.system This element is included in summaries. 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 validated at http://npc.gov.ng/birthCertificate-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:BirthCertificateNo.value This element is included in summaries. 1..1 string The client's birth certificate number
Example General: 123456
Patient.Slices for identifier.identifier:BirthCertificateNo.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:BirthCertificateNo.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:PhoneNumber This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PhoneNumber.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PhoneNumber.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:PhoneNumber.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:PhoneNumber.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PhoneNumber.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:PhoneNumber.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Patient.Slices for identifier.identifier:PhoneNumber.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PhoneNumber.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:PhoneNumber.type.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:PhoneNumber.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:PhoneNumber.type.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Required Pattern: MOBILE
Patient.Slices for identifier.identifier:PhoneNumber.type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Required Pattern: Primary Mobile Phone Number of the Client or CareGiver
Patient.Slices for identifier.identifier:PhoneNumber.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:PhoneNumber.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:PhoneNumber.system This element is included in summaries. 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 validated at http://mtnonline.com/phone-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:PhoneNumber.value This element is included in summaries. 1..1 string client's phone number which is 11 digits
Example General: 123456
Patient.Slices for identifier.identifier:PhoneNumber.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:PhoneNumber.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:InsuranceNumber This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:InsuranceNumber.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:InsuranceNumber.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:InsuranceNumber.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:InsuranceNumber.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:InsuranceNumber.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:InsuranceNumber.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Patient.Slices for identifier.identifier:InsuranceNumber.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:InsuranceNumber.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:InsuranceNumber.type.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Required Pattern: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:InsuranceNumber.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:InsuranceNumber.type.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Required Pattern: INSUR
Patient.Slices for identifier.identifier:InsuranceNumber.type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Required Pattern: The Insurance or HMO number of the client
Patient.Slices for identifier.identifier:InsuranceNumber.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:InsuranceNumber.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:InsuranceNumber.system This element is included in summaries. 0..1 uri The generating institution e.g., State, NHIA, or HMO
Example General: http://www.acme.com/identifiers/patient
Example Example Insurance system validated at http://nhia.gov.ng/insurance-no: https://nphcda.gov.ng/ig/ValueSet/patient-identifier-cs
Patient.Slices for identifier.identifier:InsuranceNumber.value This element is included in summaries. 1..1 string The actual insurance number generated at state, national or hmo authorities
Example General: 123456
Patient.Slices for identifier.identifier:InsuranceNumber.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:InsuranceNumber.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Indicates Whether this patient's record is in active use or not (eg. for Immunization, this flag can be set to true between 0-24 months, and false there after, to optimize searches)
Patient.name This element must be supported. This element is included in summaries. 1..1 HumanName A name associated with the patient
Patient.name.id 0..1 string Unique id for inter-element referencing
Patient.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.name.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.name.family This element is included in summaries. 1..1 string The surname or family name of the Immunization client
Patient.name.given This element is included in summaries. 1..* string The other names of the Immunization client like the Firstname and Middle names if applicable
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Patient.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Patient.gender This element is included in summaries. 0..1 code The sex of the Immunization client
Binding: NG Gender or Sex VS (required)
Patient.birthDate This element must be supported. This element is included in summaries. 0..1 date The date of birth of the Immunization client in the form dd-mm-yyy
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element must be supported. This element is included in summaries. 0..* Address An address for the individual
Patient.address.id 0..1 string Unique id for inter-element referencing
Patient.address.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.address.Slices for extension.extension:administrativeWard This element must be supported. 0..1 CodeableConcept NG-Imm Administrative Wards
URL: https://nphcda.gov.ng/ig/StructureDefinition/nigeria-administrative-ward
Binding: NG-Imm Wards VS (example)
Patient.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Patient.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Patient.address.line This element is included in summaries. 0..1 string The house number number, stree, 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
Patient.address.city This element is included in summaries. 0..1 string The city, village, town or settlement where the client lives in the state
Example General: Erewhon
Patient.address.district This element is included in summaries. 0..1 string The FHIR name is district, used as Nigeria LGA in this profile
Binding: NG-Imm LGAs VS (required)
Example General: Madison
Patient.address.state This element is included in summaries. 0..1 string The name of the state where the client resides in Nigeria
Binding: NG-Imm States VS (required)
Patient.address.postalCode This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
Patient.address.country This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Patient.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x] 0..1 Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean boolean
Patient.multipleBirth[x].multipleBirthInteger integer
Patient.photo 0..* Attachment Image of the patient
Patient.contact This element must be supported. C 0..* BackboneElement The contact information of the Client's primary Caregiver, can be a Parent or Guardian
Constraints: pat-1
Patient.contact.id 0..1 string Unique id for inter-element referencing
Patient.contact.extension 0..* Extension Additional content defined by implementations
Patient.contact.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.
Patient.contact.relationship.id 0..1 string Unique id for inter-element referencing
Patient.contact.relationship.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.contact.relationship.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Patient.contact.relationship.text This element is included in summaries. 0..1 string The relationship of the Client with the primary Caregiver or Guardian (eg. Parent)
Binding: NG-Imm Relationships VS (extensible)
Patient.contact.name 0..1 HumanName A name associated with the contact person
Patient.contact.name.id 0..1 string Unique id for inter-element referencing
Patient.contact.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.contact.name.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.contact.name.family This element is included in summaries. 0..1 string The surname (family) name of the Client's primary Caregiver, can be a Parent or Guardian
Patient.contact.name.given This element is included in summaries. 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
Patient.contact.name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.contact.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.contact.name.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Patient.contact.telecom This element must be supported. 0..* ContactPoint A contact detail for the person
Patient.contact.telecom.id 0..1 string Unique id for inter-element referencing
Patient.contact.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.contact.telecom.system This element is included in summaries. C 0..1 code The primary means to contact the Client's primary Caregiver or Guardian
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.contact.telecom.value This element is included in summaries. 0..1 string The primary means to value(phone no. or email address) the Client's primary Caregiver or Guardian
Patient.contact.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Patient.contact.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Patient.contact.address 0..1 Address Address for the contact person
Patient.contact.address.id 0..1 string Unique id for inter-element referencing
Patient.contact.address.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.contact.address.Slices for extension.extension:administrativeWard This element must be supported. 0..1 CodeableConcept NG-Imm Administrative Wards
URL: https://nphcda.gov.ng/ig/StructureDefinition/nigeria-administrative-ward
Binding: NG-Imm Wards VS (example)
Patient.contact.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Patient.contact.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Patient.contact.address.line This element must be supported. This element is included in summaries. 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
Patient.contact.address.city This element is included in summaries. 0..1 string The city, town or settlement where the Client's primary Caregiver or Guardian lives
Example General: Erewhon
Patient.contact.address.district This element is included in summaries. 0..1 string The LGA where the Client's primary Caregiver or Guardian lives
Binding: NG-Imm LGAs VS (required)
Example General: Madison
Patient.contact.address.state This element is included in summaries. 0..1 string The State in Nigeria where the Client's primary Caregiver or Guardian lives
Binding: NG-Imm States VS (required)
Patient.contact.address.postalCode This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
Patient.contact.address.country This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Patient.contact.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.contact.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.contact.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
Patient.communication.id 0..1 string Unique id for inter-element referencing
Patient.communication.extension 0..* Extension Additional content defined by implementations
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.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
Patient.communication.preferred 0..1 boolean Language preference indicator
Patient.generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization that is the custodian of the patient record
Patient.link This element is a modifier element. This element is included in summaries. 0..1 BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.id 0..1 string Unique id for inter-element referencing
Patient.link.extension 0..* Extension Additional content defined by implementations
Patient.link.other This element is included in summaries. 1..1 Reference(NG-Imm RelatedPerson) This link provides reference to the immunization client's Related persons
Patient.link.type This element is included in summaries. 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:ImmunizationRecordsNumber.​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.9.0 This IG
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address.district Base required NG-Imm LGAs VS 📦0.9.0 This IG
Patient.address.state Base required NG-Imm States VS 📦0.9.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-Imm Relationships VS 📦0.9.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-Imm LGAs VS 📦0.9.0 This IG
Patient.contact.address.​state Base required NG-Imm States VS 📦0.9.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(13 nested mandatory elements)
Must-Support: 16 elements
Prohibited: 16 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