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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: NG-Imm Patient

Nigeria Immunization Patient Profile

Usages:

• Use this Profile: Nigeria Immunization Bundle
• Refer to this Profile: NG-Imm Immunization, NG-Imm AllergyIntolerance, NG-Imm RelatedPerson and NG-Imm Encounter
• Examples for this Profile: Patient/ExampleNgImmPatient, Patient/ExampleNgPatientAdminWard, Patient/FullExampleNgImmPatient and Patient/NgImmExamplePatient
• CapabilityStatements using this Profile: NG-Imm Client CapabilityStatement and NG-Imm Server CapabilityStatement

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.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient			Patient
meta
lastUpdated	S	1..1	instant	The date and time when the client record was created or last updated.
implicitRules		0..0
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birthWeight	S	0..1	decimal	NG-Imm Weight at birth URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/birth-weight
extension:hivStatus	S	0..1	CodeableConcept	NG-Imm Client's HIV status URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/hiv-status Binding: NG-Imm Client HIV Status VS (required)
extension:pregnancyStatus	S	0..1	CodeableConcept	NG-Imm Client's Pregnancy status URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/pregnancy-status Binding: NG-Imm Client Preganancy Status VS (required)
extension:ageInWeeks	S	0..1	integer	NG-Imm Client Age in Weeks URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-weeks
extension:ageInMonths	S	0..1	integer	NG-Imm Client Age in Months URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-months
extension:ageInYears	S	0..1	integer	NG-Imm Client Age in Years URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-years
modifierExtension		0..0
identifier	S	1..*	Identifier	An identifier for this patient
use		0..0
system	S	1..1	uri	The organization website that assign the ID being entered (eg. https://nimc.gov.ng)
value	S	1..1	string	The actual ID value (eg. NIN35635556)
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)
name	S	1..*	HumanName	A name associated with the patient
use		0..0
family		1..1	string	The surname or family name of the Immunization client
given		1..*	string	The other names of the Immunization client
gender		0..1	code	The sex of the Immunization client Binding: AdministrativeGender (required)
birthDate	S	0..1	date	The date of birth of the Immunization client in the form dd-mm-yyy
Slices for deceased[x]		0..1	boolean, dateTime	Indicates if an individual client is alive or dead Slice: Unordered, Open by type:$this
deceased[x]:deceasedBoolean		0..1	boolean	Indicates if the individual is deceased (dead) or not
deceased[x]:deceasedDateTime		0..1	dateTime	Indicates when the individual passed away if dead.
address	S	0..*	Address	An address for the individual
Slices for extension				Content/Rules for all slices
extension:administrativeWard	S	0..1	CodeableConcept	NG-Imm Administrative Wards URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/nigeria-administrative-ward Binding: NG-Imm Wards VS (example)
use		0..0
line		0..1	string	The house number number, stree, and name where the Client lives
city		0..1	string	The city, village, town or settlement where the client lives in the state
district		0..1	string	The FHIR name is district, used as Nigeria LGA in this profile Binding: NG-Imm LGAs VS (required)
state		0..1	string	The name of the state where the client resides in Nigeria Binding: NG-Imm States VS (required)
photo	S	0..*	Attachment	Image of the patient
contentType		0..1	code	Type of image (e.g., image/jpeg)
data		0..1	base64Binary	Base64 encoded image data
url		0..1	url	Public URL or internal endpoint to the patient's photo
size		0..1	unsignedInt	The size of the image in mega bytes MB
title		0..1	string	The label of the image
contact	S	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
modifierExtension		0..0
relationship
text		0..1	string	The relationship of the Client with the primary Caregiver or Guardian (eg. Parent) Binding: NG-Imm Relationships VS (extensible)
name
use		0..0
family		0..1	string	The surname (family) name of the Client's primary Caregiver, can be a Parent or Guardian
given		0..*	string	The first name of the Client's primary Caregiver, can be a Parent or Guardian
telecom	S	0..*	ContactPoint	A contact detail for the person
system		0..1	code	The primary means to contact the Client's primary Caregiver or Guardian
value		0..1	string	The primary means to value(phone no. or email address) the Client's primary Caregiver or Guardian
use		0..0
address
Slices for extension				Content/Rules for all slices
extension:administrativeWard	S	0..1	CodeableConcept	NG-Imm Administrative Wards URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/nigeria-administrative-ward Binding: NG-Imm Wards VS (example)
use		0..0
line	S	0..1	string	The line address of the Client's primary Caregiver or Guardian
city		0..1	string	The city, town or settlement where the Client's primary Caregiver or Guardian lives
district		0..1	string	The LGA where the Client's primary Caregiver or Guardian lives Binding: NG-Imm LGAs VS (required)
state		0..1	string	The State in Nigeria where the Client's primary Caregiver or Guardian lives Binding: NG-Imm States VS (required)
communication
language		1..1	CodeableConcept	Preferred language which can be used to communicate with the patient about his or her health Binding: NG-Imm Languages VS (extensible)
link
modifierExtension		0..0
other		1..1	Reference(NG-Imm RelatedPerson)	The other patient or related person resource that the link refers to
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
Patient.address.district	required	NGLGAsVS(a valid code from NG-Imm LGAs in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-lgas From this IG
Patient.address.state	required	NGStatesVS(a valid code from NG-Imm States in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-states From this IG
Patient.contact.relationship.text	extensible	NGRelationshipsVS(a valid code from NG-Imm Relationships CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-relationship From this IG
Patient.contact.address.district	required	NGLGAsVS(a valid code from NG-Imm LGAs in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-lgas From this IG
Patient.contact.address.state	required	NGStatesVS(a valid code from NG-Imm States in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-states From this IG
Patient.communication.language	extensible	NGLanguagesVS(a valid code from NG‑Imm Languages in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-languages From this IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
meta	Σ	0..1	Meta	Metadata about the resource
lastUpdated	SΣ	1..1	instant	The date and time when the client record was created or last updated.
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birthWeight	S	0..1	decimal	NG-Imm Weight at birth URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/birth-weight
extension:hivStatus	S	0..1	CodeableConcept	NG-Imm Client's HIV status URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/hiv-status Binding: NG-Imm Client HIV Status VS (required)
extension:pregnancyStatus	S	0..1	CodeableConcept	NG-Imm Client's Pregnancy status URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/pregnancy-status Binding: NG-Imm Client Preganancy Status VS (required)
extension:ageInWeeks	S	0..1	integer	NG-Imm Client Age in Weeks URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-weeks
extension:ageInMonths	S	0..1	integer	NG-Imm Client Age in Months URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-months
extension:ageInYears	S	0..1	integer	NG-Imm Client Age in Years URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-years
identifier	SΣ	1..*	Identifier	An identifier for this patient
system	SΣ	1..1	uri	The organization website that assign the ID being entered (eg. https://nimc.gov.ng) Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The actual ID value (eg. NIN35635556) Example General: 123456
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)
name	SΣ	1..*	HumanName	A name associated with the patient
family	Σ	1..1	string	The surname or family name of the Immunization client
given	Σ	1..*	string	The other names of the Immunization client This repeating element order: Given Names appear in the correct order for presenting the name
gender	Σ	0..1	code	The sex of the Immunization client Binding: AdministrativeGender (required)
birthDate	SΣ	0..1	date	The date of birth of the Immunization client in the form dd-mm-yyy
Slices for deceased[x]	?!Σ	0..1		Indicates if an individual client is alive or dead Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	Indicates if the individual is deceased (dead) or not
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates when the individual passed away if dead.
address	SΣ	0..*	Address	An address for the individual
Slices for extension				Content/Rules for all slices
extension:administrativeWard	S	0..1	CodeableConcept	NG-Imm Administrative Wards URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/nigeria-administrative-ward Binding: NG-Imm Wards VS (example)
line	Σ	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
city	Σ	0..1	string	The city, village, town or settlement where the client lives in the state Example General: Erewhon
district	Σ	0..1	string	The FHIR name is district, used as Nigeria LGA in this profile Binding: NG-Imm LGAs VS (required) Example General: Madison
state	Σ	0..1	string	The name of the state where the client resides in Nigeria Binding: NG-Imm States VS (required)
photo	S	0..*	Attachment	Image of the patient
contentType	Σ	0..1	code	Type of image (e.g., image/jpeg) Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png
data		0..1	base64Binary	Base64 encoded image data
url	Σ	0..1	url	Public URL or internal endpoint to the patient's photo Example General: http://www.acme.com/logo-small.png
size	Σ	0..1	unsignedInt	The size of the image in mega bytes MB
title	Σ	0..1	string	The label of the image Example General: Official Corporate Logo
contact	SC	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
telecom	S	0..*	ContactPoint	A contact detail for the person
system	ΣC	0..1	code	The primary means to contact the Client's primary Caregiver or Guardian Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..1	string	The primary means to value(phone no. or email address) the Client's primary Caregiver or Guardian
address		0..1	Address	Address for the contact person
Slices for extension				Content/Rules for all slices
extension:administrativeWard	S	0..1	CodeableConcept	NG-Imm Administrative Wards URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/nigeria-administrative-ward Binding: NG-Imm Wards VS (example)
line	SΣ	0..1	string	The line address of the Client's primary Caregiver or Guardian This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	0..1	string	The city, town or settlement where the Client's primary Caregiver or Guardian lives Example General: Erewhon
district	Σ	0..1	string	The LGA where the Client's primary Caregiver or Guardian lives Binding: NG-Imm LGAs VS (required) Example General: Madison
state	Σ	0..1	string	The State in Nigeria where the Client's primary Caregiver or Guardian lives Binding: NG-Imm States VS (required)
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
other	Σ	1..1	Reference(NG-Imm RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
Patient.address.district	required	NGLGAsVS(a valid code from NG-Imm LGAs in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-lgas From this IG
Patient.address.state	required	NGStatesVS(a valid code from NG-Imm States in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-states From this IG
Patient.photo.contentType	required	Mime Types(a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard
Patient.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard
Patient.contact.address.district	required	NGLGAsVS(a valid code from NG-Imm LGAs in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-lgas From this IG
Patient.contact.address.state	required	NGStatesVS(a valid code from NG-Imm States in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-states From this IG
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	SΣ	1..1	instant	The date and time when the client record was created or last updated.
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birthWeight	S	0..1	decimal	NG-Imm Weight at birth URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/birth-weight
extension:hivStatus	S	0..1	CodeableConcept	NG-Imm Client's HIV status URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/hiv-status Binding: NG-Imm Client HIV Status VS (required)
extension:pregnancyStatus	S	0..1	CodeableConcept	NG-Imm Client's Pregnancy status URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/pregnancy-status Binding: NG-Imm Client Preganancy Status VS (required)
extension:ageInWeeks	S	0..1	integer	NG-Imm Client Age in Weeks URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-weeks
extension:ageInMonths	S	0..1	integer	NG-Imm Client Age in Months URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-months
extension:ageInYears	S	0..1	integer	NG-Imm Client Age in Years URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-years
identifier	SΣ	1..*	Identifier	An identifier for this patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The organization website that assign the ID being entered (eg. https://nimc.gov.ng) Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The actual ID value (eg. NIN35635556) Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Indicates Whether this 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)
name	SΣ	1..*	HumanName	A name associated with the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
text	Σ	0..1	string	Text representation of the full name
family	Σ	1..1	string	The surname or family name of the Immunization client
given	Σ	1..*	string	The other names of the Immunization client This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	Σ	0..*	ContactPoint	A contact detail for the individual
gender	Σ	0..1	code	The sex of the Immunization client Binding: AdministrativeGender (required)
birthDate	SΣ	0..1	date	The date of birth of the Immunization client in the form dd-mm-yyy
Slices for deceased[x]	?!Σ	0..1		Indicates if an individual client is alive or dead Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	Indicates if the individual is deceased (dead) or not
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates when the individual passed away if dead.
address	SΣ	0..*	Address	An address for the individual
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:administrativeWard	S	0..1	CodeableConcept	NG-Imm Administrative Wards URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/nigeria-administrative-ward Binding: NG-Imm Wards VS (example)
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	0..1	string	The house number 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
city	Σ	0..1	string	The city, village, town or settlement where the client lives in the state Example General: Erewhon
district	Σ	0..1	string	The FHIR name is district, used as Nigeria LGA in this profile Binding: NG-Imm LGAs VS (required) Example General: Madison
state	Σ	0..1	string	The name of the state where the client resides in Nigeria Binding: NG-Imm States VS (required)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo	S	0..*	Attachment	Image of the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contentType	Σ	0..1	code	Type of image (e.g., image/jpeg) Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding Example General: en-AU
data		0..1	base64Binary	Base64 encoded image data
url	Σ	0..1	url	Public URL or internal endpoint to the patient's photo Example General: http://www.acme.com/logo-small.png
size	Σ	0..1	unsignedInt	The size of the image in mega bytes MB
hash	Σ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	Σ	0..1	string	The label of the image Example General: Official Corporate Logo
creation	Σ	0..1	dateTime	Date attachment was first created
contact	SC	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	The relationship of the Client with the primary Caregiver or Guardian (eg. Parent) Binding: NG-Imm Relationships VS (extensible)
name		0..1	HumanName	A name associated with the contact person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
text	Σ	0..1	string	Text representation of the full name
family	Σ	0..1	string	The surname (family) name of the Client's primary Caregiver, can be a Parent or Guardian
given	Σ	0..*	string	The first name of the Client's primary Caregiver, can be a Parent or Guardian This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	S	0..*	ContactPoint	A contact detail for the person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	0..1	code	The primary means to contact the Client's primary Caregiver or Guardian Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..1	string	The primary means to value(phone no. or email address) the Client's primary Caregiver or Guardian
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
address		0..1	Address	Address for the contact person
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:administrativeWard	S	0..1	CodeableConcept	NG-Imm Administrative Wards URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/nigeria-administrative-ward Binding: NG-Imm Wards VS (example)
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..1	string	The line address of the Client's primary Caregiver or Guardian This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	0..1	string	The city, town or settlement where the Client's primary Caregiver or Guardian lives Example General: Erewhon
district	Σ	0..1	string	The LGA where the Client's primary Caregiver or Guardian lives Binding: NG-Imm LGAs VS (required) Example General: Madison
state	Σ	0..1	string	The State in Nigeria where the Client's primary Caregiver or Guardian lives Binding: NG-Imm States VS (required)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	Preferred language which can be used to communicate with the patient about his or her health Binding: NG-Imm Languages VS (extensible)
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
other	Σ	1..1	Reference(NG-Imm RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
Patient.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 From the FHIR Standard
Patient.address.district	required	NGLGAsVS(a valid code from NG-Imm LGAs in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-lgas From this IG
Patient.address.state	required	NGStatesVS(a valid code from NG-Imm States in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-states From this IG
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status From the FHIR Standard
Patient.photo.contentType	required	Mime Types(a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard
Patient.photo.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship From the FHIR Standard
Patient.contact.relationship.text	extensible	NGRelationshipsVS(a valid code from NG-Imm Relationships CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-relationship From this IG
Patient.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard
Patient.contact.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 From the FHIR Standard
Patient.contact.address.district	required	NGLGAsVS(a valid code from NG-Imm LGAs in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-lgas From this IG
Patient.contact.address.state	required	NGStatesVS(a valid code from NG-Imm States in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-states From this IG
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.communication.language	extensible	NGLanguagesVS(a valid code from NG‑Imm Languages in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-languages From this IG
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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: 6 elements(1 nested mandatory element)
Must-Support: 19 elements
Prohibited: 10 elements

Structures

This structure refers to these other structures:

• NG-Imm RelatedPerson (http://nphcda.gov.ng/ig/immunization/StructureDefinition/mother-other-children)

Extensions

This structure refers to these extensions:

• http://nphcda.gov.ng/ig/immunization/StructureDefinition/birth-weight
• http://nphcda.gov.ng/ig/immunization/StructureDefinition/hiv-status
• http://nphcda.gov.ng/ig/immunization/StructureDefinition/pregnancy-status
• http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-weeks
• http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-months
• http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-years
• http://nphcda.gov.ng/ig/immunization/StructureDefinition/nigeria-administrative-ward

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.deceased[x]

Differential View

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient			Patient
meta
lastUpdated	S	1..1	instant	The date and time when the client record was created or last updated.
implicitRules		0..0
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birthWeight	S	0..1	decimal	NG-Imm Weight at birth URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/birth-weight
extension:hivStatus	S	0..1	CodeableConcept	NG-Imm Client's HIV status URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/hiv-status Binding: NG-Imm Client HIV Status VS (required)
extension:pregnancyStatus	S	0..1	CodeableConcept	NG-Imm Client's Pregnancy status URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/pregnancy-status Binding: NG-Imm Client Preganancy Status VS (required)
extension:ageInWeeks	S	0..1	integer	NG-Imm Client Age in Weeks URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-weeks
extension:ageInMonths	S	0..1	integer	NG-Imm Client Age in Months URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-months
extension:ageInYears	S	0..1	integer	NG-Imm Client Age in Years URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-years
modifierExtension		0..0
identifier	S	1..*	Identifier	An identifier for this patient
use		0..0
system	S	1..1	uri	The organization website that assign the ID being entered (eg. https://nimc.gov.ng)
value	S	1..1	string	The actual ID value (eg. NIN35635556)
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)
name	S	1..*	HumanName	A name associated with the patient
use		0..0
family		1..1	string	The surname or family name of the Immunization client
given		1..*	string	The other names of the Immunization client
gender		0..1	code	The sex of the Immunization client Binding: AdministrativeGender (required)
birthDate	S	0..1	date	The date of birth of the Immunization client in the form dd-mm-yyy
Slices for deceased[x]		0..1	boolean, dateTime	Indicates if an individual client is alive or dead Slice: Unordered, Open by type:$this
deceased[x]:deceasedBoolean		0..1	boolean	Indicates if the individual is deceased (dead) or not
deceased[x]:deceasedDateTime		0..1	dateTime	Indicates when the individual passed away if dead.
address	S	0..*	Address	An address for the individual
Slices for extension				Content/Rules for all slices
extension:administrativeWard	S	0..1	CodeableConcept	NG-Imm Administrative Wards URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/nigeria-administrative-ward Binding: NG-Imm Wards VS (example)
use		0..0
line		0..1	string	The house number number, stree, and name where the Client lives
city		0..1	string	The city, village, town or settlement where the client lives in the state
district		0..1	string	The FHIR name is district, used as Nigeria LGA in this profile Binding: NG-Imm LGAs VS (required)
state		0..1	string	The name of the state where the client resides in Nigeria Binding: NG-Imm States VS (required)
photo	S	0..*	Attachment	Image of the patient
contentType		0..1	code	Type of image (e.g., image/jpeg)
data		0..1	base64Binary	Base64 encoded image data
url		0..1	url	Public URL or internal endpoint to the patient's photo
size		0..1	unsignedInt	The size of the image in mega bytes MB
title		0..1	string	The label of the image
contact	S	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
modifierExtension		0..0
relationship
text		0..1	string	The relationship of the Client with the primary Caregiver or Guardian (eg. Parent) Binding: NG-Imm Relationships VS (extensible)
name
use		0..0
family		0..1	string	The surname (family) name of the Client's primary Caregiver, can be a Parent or Guardian
given		0..*	string	The first name of the Client's primary Caregiver, can be a Parent or Guardian
telecom	S	0..*	ContactPoint	A contact detail for the person
system		0..1	code	The primary means to contact the Client's primary Caregiver or Guardian
value		0..1	string	The primary means to value(phone no. or email address) the Client's primary Caregiver or Guardian
use		0..0
address
Slices for extension				Content/Rules for all slices
extension:administrativeWard	S	0..1	CodeableConcept	NG-Imm Administrative Wards URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/nigeria-administrative-ward Binding: NG-Imm Wards VS (example)
use		0..0
line	S	0..1	string	The line address of the Client's primary Caregiver or Guardian
city		0..1	string	The city, town or settlement where the Client's primary Caregiver or Guardian lives
district		0..1	string	The LGA where the Client's primary Caregiver or Guardian lives Binding: NG-Imm LGAs VS (required)
state		0..1	string	The State in Nigeria where the Client's primary Caregiver or Guardian lives Binding: NG-Imm States VS (required)
communication
language		1..1	CodeableConcept	Preferred language which can be used to communicate with the patient about his or her health Binding: NG-Imm Languages VS (extensible)
link
modifierExtension		0..0
other		1..1	Reference(NG-Imm RelatedPerson)	The other patient or related person resource that the link refers to
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
Patient.address.district	required	NGLGAsVS(a valid code from NG-Imm LGAs in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-lgas From this IG
Patient.address.state	required	NGStatesVS(a valid code from NG-Imm States in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-states From this IG
Patient.contact.relationship.text	extensible	NGRelationshipsVS(a valid code from NG-Imm Relationships CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-relationship From this IG
Patient.contact.address.district	required	NGLGAsVS(a valid code from NG-Imm LGAs in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-lgas From this IG
Patient.contact.address.state	required	NGStatesVS(a valid code from NG-Imm States in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-states From this IG
Patient.communication.language	extensible	NGLanguagesVS(a valid code from NG‑Imm Languages in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-languages From this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
meta	Σ	0..1	Meta	Metadata about the resource
lastUpdated	SΣ	1..1	instant	The date and time when the client record was created or last updated.
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birthWeight	S	0..1	decimal	NG-Imm Weight at birth URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/birth-weight
extension:hivStatus	S	0..1	CodeableConcept	NG-Imm Client's HIV status URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/hiv-status Binding: NG-Imm Client HIV Status VS (required)
extension:pregnancyStatus	S	0..1	CodeableConcept	NG-Imm Client's Pregnancy status URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/pregnancy-status Binding: NG-Imm Client Preganancy Status VS (required)
extension:ageInWeeks	S	0..1	integer	NG-Imm Client Age in Weeks URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-weeks
extension:ageInMonths	S	0..1	integer	NG-Imm Client Age in Months URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-months
extension:ageInYears	S	0..1	integer	NG-Imm Client Age in Years URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-years
identifier	SΣ	1..*	Identifier	An identifier for this patient
system	SΣ	1..1	uri	The organization website that assign the ID being entered (eg. https://nimc.gov.ng) Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The actual ID value (eg. NIN35635556) Example General: 123456
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)
name	SΣ	1..*	HumanName	A name associated with the patient
family	Σ	1..1	string	The surname or family name of the Immunization client
given	Σ	1..*	string	The other names of the Immunization client This repeating element order: Given Names appear in the correct order for presenting the name
gender	Σ	0..1	code	The sex of the Immunization client Binding: AdministrativeGender (required)
birthDate	SΣ	0..1	date	The date of birth of the Immunization client in the form dd-mm-yyy
Slices for deceased[x]	?!Σ	0..1		Indicates if an individual client is alive or dead Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	Indicates if the individual is deceased (dead) or not
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates when the individual passed away if dead.
address	SΣ	0..*	Address	An address for the individual
Slices for extension				Content/Rules for all slices
extension:administrativeWard	S	0..1	CodeableConcept	NG-Imm Administrative Wards URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/nigeria-administrative-ward Binding: NG-Imm Wards VS (example)
line	Σ	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
city	Σ	0..1	string	The city, village, town or settlement where the client lives in the state Example General: Erewhon
district	Σ	0..1	string	The FHIR name is district, used as Nigeria LGA in this profile Binding: NG-Imm LGAs VS (required) Example General: Madison
state	Σ	0..1	string	The name of the state where the client resides in Nigeria Binding: NG-Imm States VS (required)
photo	S	0..*	Attachment	Image of the patient
contentType	Σ	0..1	code	Type of image (e.g., image/jpeg) Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png
data		0..1	base64Binary	Base64 encoded image data
url	Σ	0..1	url	Public URL or internal endpoint to the patient's photo Example General: http://www.acme.com/logo-small.png
size	Σ	0..1	unsignedInt	The size of the image in mega bytes MB
title	Σ	0..1	string	The label of the image Example General: Official Corporate Logo
contact	SC	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
telecom	S	0..*	ContactPoint	A contact detail for the person
system	ΣC	0..1	code	The primary means to contact the Client's primary Caregiver or Guardian Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..1	string	The primary means to value(phone no. or email address) the Client's primary Caregiver or Guardian
address		0..1	Address	Address for the contact person
Slices for extension				Content/Rules for all slices
extension:administrativeWard	S	0..1	CodeableConcept	NG-Imm Administrative Wards URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/nigeria-administrative-ward Binding: NG-Imm Wards VS (example)
line	SΣ	0..1	string	The line address of the Client's primary Caregiver or Guardian This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	0..1	string	The city, town or settlement where the Client's primary Caregiver or Guardian lives Example General: Erewhon
district	Σ	0..1	string	The LGA where the Client's primary Caregiver or Guardian lives Binding: NG-Imm LGAs VS (required) Example General: Madison
state	Σ	0..1	string	The State in Nigeria where the Client's primary Caregiver or Guardian lives Binding: NG-Imm States VS (required)
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
other	Σ	1..1	Reference(NG-Imm RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
Patient.address.district	required	NGLGAsVS(a valid code from NG-Imm LGAs in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-lgas From this IG
Patient.address.state	required	NGStatesVS(a valid code from NG-Imm States in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-states From this IG
Patient.photo.contentType	required	Mime Types(a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard
Patient.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard
Patient.contact.address.district	required	NGLGAsVS(a valid code from NG-Imm LGAs in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-lgas From this IG
Patient.contact.address.state	required	NGStatesVS(a valid code from NG-Imm States in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-states From this IG
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	SΣ	1..1	instant	The date and time when the client record was created or last updated.
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birthWeight	S	0..1	decimal	NG-Imm Weight at birth URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/birth-weight
extension:hivStatus	S	0..1	CodeableConcept	NG-Imm Client's HIV status URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/hiv-status Binding: NG-Imm Client HIV Status VS (required)
extension:pregnancyStatus	S	0..1	CodeableConcept	NG-Imm Client's Pregnancy status URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/pregnancy-status Binding: NG-Imm Client Preganancy Status VS (required)
extension:ageInWeeks	S	0..1	integer	NG-Imm Client Age in Weeks URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-weeks
extension:ageInMonths	S	0..1	integer	NG-Imm Client Age in Months URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-months
extension:ageInYears	S	0..1	integer	NG-Imm Client Age in Years URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-years
identifier	SΣ	1..*	Identifier	An identifier for this patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The organization website that assign the ID being entered (eg. https://nimc.gov.ng) Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The actual ID value (eg. NIN35635556) Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Indicates Whether this 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)
name	SΣ	1..*	HumanName	A name associated with the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
text	Σ	0..1	string	Text representation of the full name
family	Σ	1..1	string	The surname or family name of the Immunization client
given	Σ	1..*	string	The other names of the Immunization client This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	Σ	0..*	ContactPoint	A contact detail for the individual
gender	Σ	0..1	code	The sex of the Immunization client Binding: AdministrativeGender (required)
birthDate	SΣ	0..1	date	The date of birth of the Immunization client in the form dd-mm-yyy
Slices for deceased[x]	?!Σ	0..1		Indicates if an individual client is alive or dead Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	Indicates if the individual is deceased (dead) or not
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates when the individual passed away if dead.
address	SΣ	0..*	Address	An address for the individual
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:administrativeWard	S	0..1	CodeableConcept	NG-Imm Administrative Wards URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/nigeria-administrative-ward Binding: NG-Imm Wards VS (example)
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	0..1	string	The house number 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
city	Σ	0..1	string	The city, village, town or settlement where the client lives in the state Example General: Erewhon
district	Σ	0..1	string	The FHIR name is district, used as Nigeria LGA in this profile Binding: NG-Imm LGAs VS (required) Example General: Madison
state	Σ	0..1	string	The name of the state where the client resides in Nigeria Binding: NG-Imm States VS (required)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo	S	0..*	Attachment	Image of the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contentType	Σ	0..1	code	Type of image (e.g., image/jpeg) Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding Example General: en-AU
data		0..1	base64Binary	Base64 encoded image data
url	Σ	0..1	url	Public URL or internal endpoint to the patient's photo Example General: http://www.acme.com/logo-small.png
size	Σ	0..1	unsignedInt	The size of the image in mega bytes MB
hash	Σ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	Σ	0..1	string	The label of the image Example General: Official Corporate Logo
creation	Σ	0..1	dateTime	Date attachment was first created
contact	SC	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	The relationship of the Client with the primary Caregiver or Guardian (eg. Parent) Binding: NG-Imm Relationships VS (extensible)
name		0..1	HumanName	A name associated with the contact person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
text	Σ	0..1	string	Text representation of the full name
family	Σ	0..1	string	The surname (family) name of the Client's primary Caregiver, can be a Parent or Guardian
given	Σ	0..*	string	The first name of the Client's primary Caregiver, can be a Parent or Guardian This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	S	0..*	ContactPoint	A contact detail for the person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	0..1	code	The primary means to contact the Client's primary Caregiver or Guardian Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..1	string	The primary means to value(phone no. or email address) the Client's primary Caregiver or Guardian
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
address		0..1	Address	Address for the contact person
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:administrativeWard	S	0..1	CodeableConcept	NG-Imm Administrative Wards URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/nigeria-administrative-ward Binding: NG-Imm Wards VS (example)
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..1	string	The line address of the Client's primary Caregiver or Guardian This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	0..1	string	The city, town or settlement where the Client's primary Caregiver or Guardian lives Example General: Erewhon
district	Σ	0..1	string	The LGA where the Client's primary Caregiver or Guardian lives Binding: NG-Imm LGAs VS (required) Example General: Madison
state	Σ	0..1	string	The State in Nigeria where the Client's primary Caregiver or Guardian lives Binding: NG-Imm States VS (required)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	Preferred language which can be used to communicate with the patient about his or her health Binding: NG-Imm Languages VS (extensible)
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
other	Σ	1..1	Reference(NG-Imm RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
Patient.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 From the FHIR Standard
Patient.address.district	required	NGLGAsVS(a valid code from NG-Imm LGAs in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-lgas From this IG
Patient.address.state	required	NGStatesVS(a valid code from NG-Imm States in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-states From this IG
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status From the FHIR Standard
Patient.photo.contentType	required	Mime Types(a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard
Patient.photo.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship From the FHIR Standard
Patient.contact.relationship.text	extensible	NGRelationshipsVS(a valid code from NG-Imm Relationships CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-relationship From this IG
Patient.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard
Patient.contact.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 From the FHIR Standard
Patient.contact.address.district	required	NGLGAsVS(a valid code from NG-Imm LGAs in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-lgas From this IG
Patient.contact.address.state	required	NGStatesVS(a valid code from NG-Imm States in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-states From this IG
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.communication.language	extensible	NGLanguagesVS(a valid code from NG‑Imm Languages in Nigeria CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-languages From this IG
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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: 6 elements(1 nested mandatory element)
Must-Support: 19 elements
Prohibited: 10 elements

Structures

This structure refers to these other structures:

• NG-Imm RelatedPerson (http://nphcda.gov.ng/ig/immunization/StructureDefinition/mother-other-children)

Extensions

This structure refers to these extensions:

• http://nphcda.gov.ng/ig/immunization/StructureDefinition/birth-weight
• http://nphcda.gov.ng/ig/immunization/StructureDefinition/hiv-status
• http://nphcda.gov.ng/ig/immunization/StructureDefinition/pregnancy-status
• http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-weeks
• http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-months
• http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-years
• http://nphcda.gov.ng/ig/immunization/StructureDefinition/nigeria-administrative-ward

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.deceased[x]