Botswana FHIR Implementation Guide, published by Jembi Health Systems. 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/jembi/botswana-hie-fhir-ig/ and changes regularly. See the Directory of published versions

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

Resource Profile: Patient - Patient Identity Cross Reference

Is used by the Client Registry to re-identify the patient with his/her corresponding longitudinal clinical record.

Usages:

• Use this Profile: Bundle - Process Patient in FHIR
• Examples for this Profile: Patient/RestrictedPatientExample1 and Patient/RestrictedPatientExample2
• CapabilityStatements using this Profile: Botswana HIE Server Capability Statement

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
id	Σ	0..1	id	Must be the same ID as the patient resource that suppplied the personal data during creation
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained	S	0..1	Patient	Contained patient data
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:MasterPatientIndex	Σ	1..*	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/mpi
value	ΣC	1..1	string	The value that is unique Example General: 123456
identifier:MRN	SΣ	0..1	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/mrn
value	ΣC	1..1	string	The value that is unique Example General: 123456
identifier:Internal	SΣ	0..1	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/internalid
value	ΣC	1..1	string	The value that is unique Example General: 123456
identifier:PIMS	SΣ	0..1	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/pims
value	ΣC	1..1	string	The value that is unique Example General: 123456
identifier:OpenMRS	SΣ	0..1	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/openmrs
value	ΣC	1..1	string	The value that is unique Example General: 123456
managingOrganization	SΣ	0..1	Reference(Service Provider)	Organization that is the custodian of the patient record
Slices for link	?!SΣ	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual individual Slice: Unordered, Open by value:other.display
link:All Slices				Content/Rules for all slices
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
link:PatientData	?!SΣ	0..1	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
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
display	ΣC	1..1	string	Text alternative for the resource Required Pattern: Patient data provided by Client Registry
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 Required Pattern: seealso
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.identifier:MasterPatientIndex.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Patient.identifier:MRN.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Patient.identifier:Internal.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Patient.identifier:PIMS.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Patient.identifier:OpenMRS.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|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
Patient.link:PatientData.type	required	Pattern Value: seealso 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		0..*	Patient	Information about an individual or animal receiving health care services
id		0..1	id	Must be the same ID as the patient resource that suppplied the personal data during creation
contained	S	0..1	Patient	Contained patient data
Slices for identifier		1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:MasterPatientIndex		1..*	Identifier	An identifier for this patient
system		1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/mpi
value		1..1	string	The value that is unique
identifier:MRN	S	0..1	Identifier	An identifier for this patient
system		1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/mrn
value		1..1	string	The value that is unique
identifier:Internal	S	0..1	Identifier	An identifier for this patient
system		1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/internalid
value		1..1	string	The value that is unique
identifier:PIMS	S	0..1	Identifier	An identifier for this patient
system		1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/pims
value		1..1	string	The value that is unique
identifier:OpenMRS	S	0..1	Identifier	An identifier for this patient
system		1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/openmrs
value		1..1	string	The value that is unique
active		0..0
name		0..0
telecom		0..0
gender		0..0
birthDate		0..0
deceased[x]		0..0
address		0..0
maritalStatus		0..0
multipleBirth[x]		0..0
photo		0..0
contact		0..0
communication		0..0
generalPractitioner		0..0
managingOrganization	S	0..1	Reference(Service Provider)	Organization that is the custodian of the patient record
Slices for link	S	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual individual Slice: Unordered, Open by value:other.display
link:PatientData	S	0..1	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual individual
other
reference		1..1	string	Literal reference, Relative, internal or absolute URL
display		1..1	string	Text alternative for the resource Required Pattern: Patient data provided by Client Registry
type		1..1	code	replaced-by | replaces | refer | seealso Required Pattern: seealso
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	Must be the same ID as the patient resource that suppplied the personal data during creation
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	S	0..1	Patient	Contained patient data
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:MasterPatientIndex	Σ	1..*	Identifier	An identifier for this 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	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/mpi
value	ΣC	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:MRN	SΣ	0..1	Identifier	An identifier for this 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	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/mrn
value	ΣC	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:Internal	SΣ	0..1	Identifier	An identifier for this 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	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/internalid
value	ΣC	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:PIMS	SΣ	0..1	Identifier	An identifier for this 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	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/pims
value	ΣC	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:OpenMRS	SΣ	0..1	Identifier	An identifier for this 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	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/openmrs
value	ΣC	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
managingOrganization	SΣ	0..1	Reference(Service Provider)	Organization that is the custodian of the patient record
Slices for link	?!SΣ	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual individual Slice: Unordered, Open by value:other.display
link:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
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
link:PatientData	?!SΣ	0..1	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
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
display	ΣC	1..1	string	Text alternative for the resource Required Pattern: Patient data provided by Client Registry
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 Required Pattern: seealso
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.identifier:MasterPatientIndex.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Patient.identifier:MasterPatientIndex.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.identifier:MRN.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Patient.identifier:MRN.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.identifier:Internal.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Patient.identifier:Internal.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.identifier:PIMS.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Patient.identifier:PIMS.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.identifier:OpenMRS.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Patient.identifier:OpenMRS.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type 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
Patient.link:PatientData.other.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Patient.link:PatientData.type	required	Pattern Value: seealso 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

Summary

Mandatory: 4 elements(10 nested mandatory elements)
Must-Support: 8 elements
Prohibited: 13 elements

Structures

This structure refers to these other structures:

• Service Provider (http://moh.bw.org/StructureDefinition/service-organization)

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.link

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
id	Σ	0..1	id	Must be the same ID as the patient resource that suppplied the personal data during creation
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained	S	0..1	Patient	Contained patient data
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:MasterPatientIndex	Σ	1..*	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/mpi
value	ΣC	1..1	string	The value that is unique Example General: 123456
identifier:MRN	SΣ	0..1	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/mrn
value	ΣC	1..1	string	The value that is unique Example General: 123456
identifier:Internal	SΣ	0..1	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/internalid
value	ΣC	1..1	string	The value that is unique Example General: 123456
identifier:PIMS	SΣ	0..1	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/pims
value	ΣC	1..1	string	The value that is unique Example General: 123456
identifier:OpenMRS	SΣ	0..1	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/openmrs
value	ΣC	1..1	string	The value that is unique Example General: 123456
managingOrganization	SΣ	0..1	Reference(Service Provider)	Organization that is the custodian of the patient record
Slices for link	?!SΣ	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual individual Slice: Unordered, Open by value:other.display
link:All Slices				Content/Rules for all slices
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
link:PatientData	?!SΣ	0..1	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
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
display	ΣC	1..1	string	Text alternative for the resource Required Pattern: Patient data provided by Client Registry
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 Required Pattern: seealso
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.identifier:MasterPatientIndex.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Patient.identifier:MRN.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Patient.identifier:Internal.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Patient.identifier:PIMS.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Patient.identifier:OpenMRS.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|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
Patient.link:PatientData.type	required	Pattern Value: seealso 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		0..*	Patient	Information about an individual or animal receiving health care services
id		0..1	id	Must be the same ID as the patient resource that suppplied the personal data during creation
contained	S	0..1	Patient	Contained patient data
Slices for identifier		1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:MasterPatientIndex		1..*	Identifier	An identifier for this patient
system		1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/mpi
value		1..1	string	The value that is unique
identifier:MRN	S	0..1	Identifier	An identifier for this patient
system		1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/mrn
value		1..1	string	The value that is unique
identifier:Internal	S	0..1	Identifier	An identifier for this patient
system		1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/internalid
value		1..1	string	The value that is unique
identifier:PIMS	S	0..1	Identifier	An identifier for this patient
system		1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/pims
value		1..1	string	The value that is unique
identifier:OpenMRS	S	0..1	Identifier	An identifier for this patient
system		1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/openmrs
value		1..1	string	The value that is unique
active		0..0
name		0..0
telecom		0..0
gender		0..0
birthDate		0..0
deceased[x]		0..0
address		0..0
maritalStatus		0..0
multipleBirth[x]		0..0
photo		0..0
contact		0..0
communication		0..0
generalPractitioner		0..0
managingOrganization	S	0..1	Reference(Service Provider)	Organization that is the custodian of the patient record
Slices for link	S	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual individual Slice: Unordered, Open by value:other.display
link:PatientData	S	0..1	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual individual
other
reference		1..1	string	Literal reference, Relative, internal or absolute URL
display		1..1	string	Text alternative for the resource Required Pattern: Patient data provided by Client Registry
type		1..1	code	replaced-by | replaces | refer | seealso Required Pattern: seealso
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	Must be the same ID as the patient resource that suppplied the personal data during creation
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	S	0..1	Patient	Contained patient data
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:MasterPatientIndex	Σ	1..*	Identifier	An identifier for this 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	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/mpi
value	ΣC	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:MRN	SΣ	0..1	Identifier	An identifier for this 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	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/mrn
value	ΣC	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:Internal	SΣ	0..1	Identifier	An identifier for this 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	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/internalid
value	ΣC	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:PIMS	SΣ	0..1	Identifier	An identifier for this 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	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/pims
value	ΣC	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:OpenMRS	SΣ	0..1	Identifier	An identifier for this 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	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/openmrs
value	ΣC	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
managingOrganization	SΣ	0..1	Reference(Service Provider)	Organization that is the custodian of the patient record
Slices for link	?!SΣ	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual individual Slice: Unordered, Open by value:other.display
link:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
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
link:PatientData	?!SΣ	0..1	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
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
display	ΣC	1..1	string	Text alternative for the resource Required Pattern: Patient data provided by Client Registry
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 Required Pattern: seealso
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.identifier:MasterPatientIndex.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Patient.identifier:MasterPatientIndex.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.identifier:MRN.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Patient.identifier:MRN.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.identifier:Internal.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Patient.identifier:Internal.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.identifier:PIMS.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Patient.identifier:PIMS.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.identifier:OpenMRS.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Patient.identifier:OpenMRS.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type 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
Patient.link:PatientData.other.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Patient.link:PatientData.type	required	Pattern Value: seealso 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

Summary

Mandatory: 4 elements(10 nested mandatory elements)
Must-Support: 8 elements
Prohibited: 13 elements

Structures

This structure refers to these other structures:

• Service Provider (http://moh.bw.org/StructureDefinition/service-organization)

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.link

Other representations of profile: CSV, Excel, Schematron