Nepal HMIS FHIR Implementation Guide – 🚨 DRAFT VERSION - Local Development build (v0.0.1-ballot) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: NP Core Patient Profile

The NP Core Patient Profile inherits from the FHIR Patient resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Patient resource to record, search, and fetch core patient information within the Nepal health system. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. By providing a standardized foundation for capturing patient demographics, identifiers, and key health attributes, this profile promotes interoperability, consistent data capture, and adoption across national health programs

Usages:

• Refer to this Profile: NP Core Encounter Profile, NP Core Immunization Profile and NP Core Medication Dispense Profile
• Examples for this Profile: Patient/patient-child and Patient/patient-pregnant

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.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ethnicCode		0..1	Coding	Ethnic Code URL: https://fhir.hmis.gov.np/StructureDefinition/ethnic-code Binding: Ethnic Code (required)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	1..4	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:NationalID	Σ	0..1	Identifier	An identifier for this patient
identifier:HealthID	Σ	0..1	Identifier	An identifier for this patient
identifier:SystemID	Σ	0..1	Identifier	An identifier for this patient
identifier:MasterID	Σ	0..1	Identifier	An identifier for this patient
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	Σ	1..1	HumanName	A name associated with the patient
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official
text	Σ	1..1	string	Text representation of the full name
family	Σ	1..1	string	Family name (often called 'Surname')
given	Σ	1..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Slices for telecom	Σ	0..1	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system
telecom:Phone	Σ	0..1	ContactPoint	A contact detail for the individual
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
telecom:Email	Σ	0..1	ContactPoint	A contact detail for the individual
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
gender	Σ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	1..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	Σ	0..1	Address	An address for the individual
Slices for extension				Content/Rules for all slices
extension:nepalAddress		0..1	(Complex)	Nepal Address URL: https://fhir.hmis.gov.np/StructureDefinition/NepalAddress
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home
link	?!Σ	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual individual
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.name.use	required	Pattern Value: official http://hl7.org/fhir/ValueSet/name-use|5.0.0 From the FHIR Standard
Patient.telecom:Phone.system	required	Pattern Value: phone http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 From the FHIR Standard
Patient.telecom:Phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 From the FHIR Standard
Patient.telecom:Email.system	required	Pattern Value: email http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 From the FHIR Standard
Patient.telecom:Email.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 From the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|5.0.0 From the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient			Patient
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ethnicCode		0..1	Coding	Ethnic Code URL: https://fhir.hmis.gov.np/StructureDefinition/ethnic-code Binding: Ethnic Code (required)
Slices for identifier		1..4	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:NationalID		0..1	Identifier	An identifier for this patient
identifier:HealthID		0..1	Identifier	An identifier for this patient
identifier:SystemID		0..1	Identifier	An identifier for this patient
identifier:MasterID		0..1	Identifier	An identifier for this patient
name		1..1	HumanName	A name associated with the patient
use		1..1	code	usual | official | temp | nickname | anonymous | old | maiden Required Pattern: official
text		1..1	string	Text representation of the full name
family		1..1	string	Family name (often called 'Surname')
given		1..*	string	Given names (not always 'first'). Includes middle names
Slices for telecom		0..1	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system
telecom:Phone		0..1	ContactPoint	A contact detail for the individual
system		1..1	code	phone | fax | email | pager | url | sms | other Required Pattern: phone
telecom:Email		0..1	ContactPoint	A contact detail for the individual
system		1..1	code	phone | fax | email | pager | url | sms | other Required Pattern: email
gender		1..1	code	male | female | other | unknown
birthDate		1..1	date	The date of birth for the individual
address		0..1	Address	An address for the individual
Slices for extension				Content/Rules for all slices
extension:nepalAddress		0..1	(Complex)	Nepal Address URL: https://fhir.hmis.gov.np/StructureDefinition/NepalAddress
Documentation for this format

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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
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:ethnicCode		0..1	Coding	Ethnic Code URL: https://fhir.hmis.gov.np/StructureDefinition/ethnic-code Binding: Ethnic Code (required)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	1..4	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:NationalID	Σ	0..1	Identifier	An identifier for this patient
identifier:HealthID	Σ	0..1	Identifier	An identifier for this patient
identifier:SystemID	Σ	0..1	Identifier	An identifier for this patient
identifier:MasterID	Σ	0..1	Identifier	An identifier for this patient
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	Σ	1..1	HumanName	A name associated with the patient
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official
text	Σ	1..1	string	Text representation of the full name
family	Σ	1..1	string	Family name (often called 'Surname')
given	Σ	1..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
Slices for telecom	Σ	0..1	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system
telecom:Phone	Σ	0..1	ContactPoint	A contact detail for the individual
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value	ΣC	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
telecom:Email	Σ	0..1	ContactPoint	A contact detail for the individual
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
value	ΣC	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
gender	Σ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	1..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	Σ	0..1	Address	An address for the individual
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:nepalAddress		0..1	(Complex)	Nepal Address URL: https://fhir.hmis.gov.np/StructureDefinition/NepalAddress
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. may 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: MaritalStatusCodes (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name	C	0..1	HumanName	A name associated with the contact person
telecom	C	0..*	ContactPoint	A contact detail for the person
address	C	0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
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 a Patient or RelatedPerson resource that concerns the same actual individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard
Patient.name.use	required	Pattern Value: official http://hl7.org/fhir/ValueSet/name-use|5.0.0 From the FHIR Standard
Patient.telecom:Phone.system	required	Pattern Value: phone http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 From the FHIR Standard
Patient.telecom:Phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 From the FHIR Standard
Patient.telecom:Email.system	required	Pattern Value: email http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 From the FHIR Standard
Patient.telecom:Email.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 From the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|5.0.0 From the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|5.0.0 From the FHIR Standard
Patient.maritalStatus	extensible	MaritalStatusCodes http://hl7.org/fhir/ValueSet/marital-status From the FHIR Standard
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship From the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 From the FHIR Standard
Patient.communication.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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: 8 elements(2 nested mandatory elements)

Extensions

This structure refers to these extensions:

• https://fhir.hmis.gov.np/StructureDefinition/ethnic-code
• https://fhir.hmis.gov.np/StructureDefinition/NepalAddress

Slices

This structure defines the following Slices:

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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ethnicCode		0..1	Coding	Ethnic Code URL: https://fhir.hmis.gov.np/StructureDefinition/ethnic-code Binding: Ethnic Code (required)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	1..4	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:NationalID	Σ	0..1	Identifier	An identifier for this patient
identifier:HealthID	Σ	0..1	Identifier	An identifier for this patient
identifier:SystemID	Σ	0..1	Identifier	An identifier for this patient
identifier:MasterID	Σ	0..1	Identifier	An identifier for this patient
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	Σ	1..1	HumanName	A name associated with the patient
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official
text	Σ	1..1	string	Text representation of the full name
family	Σ	1..1	string	Family name (often called 'Surname')
given	Σ	1..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Slices for telecom	Σ	0..1	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system
telecom:Phone	Σ	0..1	ContactPoint	A contact detail for the individual
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
telecom:Email	Σ	0..1	ContactPoint	A contact detail for the individual
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
gender	Σ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	1..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	Σ	0..1	Address	An address for the individual
Slices for extension				Content/Rules for all slices
extension:nepalAddress		0..1	(Complex)	Nepal Address URL: https://fhir.hmis.gov.np/StructureDefinition/NepalAddress
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home
link	?!Σ	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual individual
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.name.use	required	Pattern Value: official http://hl7.org/fhir/ValueSet/name-use|5.0.0 From the FHIR Standard
Patient.telecom:Phone.system	required	Pattern Value: phone http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 From the FHIR Standard
Patient.telecom:Phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 From the FHIR Standard
Patient.telecom:Email.system	required	Pattern Value: email http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 From the FHIR Standard
Patient.telecom:Email.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 From the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|5.0.0 From the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient			Patient
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ethnicCode		0..1	Coding	Ethnic Code URL: https://fhir.hmis.gov.np/StructureDefinition/ethnic-code Binding: Ethnic Code (required)
Slices for identifier		1..4	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:NationalID		0..1	Identifier	An identifier for this patient
identifier:HealthID		0..1	Identifier	An identifier for this patient
identifier:SystemID		0..1	Identifier	An identifier for this patient
identifier:MasterID		0..1	Identifier	An identifier for this patient
name		1..1	HumanName	A name associated with the patient
use		1..1	code	usual | official | temp | nickname | anonymous | old | maiden Required Pattern: official
text		1..1	string	Text representation of the full name
family		1..1	string	Family name (often called 'Surname')
given		1..*	string	Given names (not always 'first'). Includes middle names
Slices for telecom		0..1	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system
telecom:Phone		0..1	ContactPoint	A contact detail for the individual
system		1..1	code	phone | fax | email | pager | url | sms | other Required Pattern: phone
telecom:Email		0..1	ContactPoint	A contact detail for the individual
system		1..1	code	phone | fax | email | pager | url | sms | other Required Pattern: email
gender		1..1	code	male | female | other | unknown
birthDate		1..1	date	The date of birth for the individual
address		0..1	Address	An address for the individual
Slices for extension				Content/Rules for all slices
extension:nepalAddress		0..1	(Complex)	Nepal Address URL: https://fhir.hmis.gov.np/StructureDefinition/NepalAddress
Documentation for this format

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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
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:ethnicCode		0..1	Coding	Ethnic Code URL: https://fhir.hmis.gov.np/StructureDefinition/ethnic-code Binding: Ethnic Code (required)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	1..4	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:NationalID	Σ	0..1	Identifier	An identifier for this patient
identifier:HealthID	Σ	0..1	Identifier	An identifier for this patient
identifier:SystemID	Σ	0..1	Identifier	An identifier for this patient
identifier:MasterID	Σ	0..1	Identifier	An identifier for this patient
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	Σ	1..1	HumanName	A name associated with the patient
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official
text	Σ	1..1	string	Text representation of the full name
family	Σ	1..1	string	Family name (often called 'Surname')
given	Σ	1..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
Slices for telecom	Σ	0..1	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system
telecom:Phone	Σ	0..1	ContactPoint	A contact detail for the individual
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value	ΣC	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
telecom:Email	Σ	0..1	ContactPoint	A contact detail for the individual
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
value	ΣC	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
gender	Σ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	1..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	Σ	0..1	Address	An address for the individual
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:nepalAddress		0..1	(Complex)	Nepal Address URL: https://fhir.hmis.gov.np/StructureDefinition/NepalAddress
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. may 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: MaritalStatusCodes (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name	C	0..1	HumanName	A name associated with the contact person
telecom	C	0..*	ContactPoint	A contact detail for the person
address	C	0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
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 a Patient or RelatedPerson resource that concerns the same actual individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard
Patient.name.use	required	Pattern Value: official http://hl7.org/fhir/ValueSet/name-use|5.0.0 From the FHIR Standard
Patient.telecom:Phone.system	required	Pattern Value: phone http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 From the FHIR Standard
Patient.telecom:Phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 From the FHIR Standard
Patient.telecom:Email.system	required	Pattern Value: email http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 From the FHIR Standard
Patient.telecom:Email.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 From the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|5.0.0 From the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|5.0.0 From the FHIR Standard
Patient.maritalStatus	extensible	MaritalStatusCodes http://hl7.org/fhir/ValueSet/marital-status From the FHIR Standard
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship From the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 From the FHIR Standard
Patient.communication.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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: 8 elements(2 nested mandatory elements)

Extensions

This structure refers to these extensions:

• https://fhir.hmis.gov.np/StructureDefinition/ethnic-code
• https://fhir.hmis.gov.np/StructureDefinition/NepalAddress

Slices

This structure defines the following Slices:

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

Other representations of profile: CSV, Excel, Schematron