Botswana FHIR Implementation Guide
1.0.0 - ci-build Botswana flag

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

Resource Profile: Patient - Patient Identity Cross Reference

Official URL: http://moh.bw.org/StructureDefinition/patient-identity-cross-reference Version: 1.0.0
Active as of 2026-10-13 Computable Name: RestrictedPatient

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

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.id This element is included in summaries. 0..1 id Must be the same ID as the patient resource that suppplied the personal data during creation
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.contained This element must be supported. 0..1 Patient Contained patient data
Patient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element is included in summaries. 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:MasterPatientIndex This element is included in summaries. 1..* Identifier An identifier for this patient
Patient.Slices for identifier.identifier:MasterPatientIndex.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:MasterPatientIndex.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/mpi
Patient.Slices for identifier.identifier:MasterPatientIndex.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:MRN This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:MRN.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:MRN.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/mrn
Patient.Slices for identifier.identifier:MRN.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:Internal This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:Internal.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:Internal.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/internalid
Patient.Slices for identifier.identifier:Internal.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:PIMS This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PIMS.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:PIMS.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/pims
Patient.Slices for identifier.identifier:PIMS.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:OpenMRS This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:OpenMRS.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:OpenMRS.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/openmrs
Patient.Slices for identifier.identifier:OpenMRS.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.managingOrganization This element must be supported. This element is included in summaries. 0..1 Reference(Service Provider) Organization that is the custodian of the patient record
Patient.Slices for link This element is a modifier element. This element must be supported. This element is included in summaries. 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
Slice: Unordered, Open by value:other.display

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for link.link:All Slices Content/Rules for all slices
Patient.Slices for link.link:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for link.link:All Slices.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.Slices for link.link:All Slices.type This element is included in summaries. 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
Patient.Slices for link.link:PatientData This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
Patient.Slices for link.link:PatientData.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for link.link:PatientData.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.Slices for link.link:PatientData.other.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
Patient.Slices for link.link:PatientData.other.display This element is included in summaries. C 1..1 string Text alternative for the resource
Required Pattern: Patient data provided by Client Registry
Patient.Slices for link.link:PatientData.type This element is included in summaries. 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier:MasterPatientIndex.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:MRN.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:Internal.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:PIMS.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:OpenMRS.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.communication.​language Base required All Languages 📍5.0.0 FHIR Std.
Patient.link.type Base required Link Type 📍5.0.0 FHIR Std.
Patient.link:PatientData.​type Base required Link Type 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.id 0..1 id Must be the same ID as the patient resource that suppplied the personal data during creation
Patient.contained This element must be supported. 0..1 Patient Contained patient data
Patient.Slices for identifier 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:MasterPatientIndex 1..* Identifier An identifier for this patient
Patient.Slices for identifier.identifier:MasterPatientIndex.system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/mpi
Patient.Slices for identifier.identifier:MasterPatientIndex.value 1..1 string The value that is unique
Patient.Slices for identifier.identifier:MRN This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:MRN.system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/mrn
Patient.Slices for identifier.identifier:MRN.value 1..1 string The value that is unique
Patient.Slices for identifier.identifier:Internal This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:Internal.system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/internalid
Patient.Slices for identifier.identifier:Internal.value 1..1 string The value that is unique
Patient.Slices for identifier.identifier:PIMS This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PIMS.system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/pims
Patient.Slices for identifier.identifier:PIMS.value 1..1 string The value that is unique
Patient.Slices for identifier.identifier:OpenMRS This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:OpenMRS.system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/openmrs
Patient.Slices for identifier.identifier:OpenMRS.value 1..1 string The value that is unique
Patient.name 0..0 A name associated with the patient
Patient.telecom 0..0 A contact detail for the individual
Patient.gender 0..0 male | female | other | unknown
Patient.birthDate 0..0 The date of birth for the individual
Patient.deceased[x] 0..0 Indicates if the individual is deceased or not
Patient.address 0..0 An address for the individual
Patient.maritalStatus 0..0 Marital (civil) status of a patient
Patient.multipleBirth[x] 0..0 Whether patient is part of a multiple birth
Patient.photo 0..0 Image of the patient
Patient.contact 0..0 A contact party (e.g. guardian, partner, friend) for the patient
Patient.communication 0..0 A language which may be used to communicate with the patient about his or her health
Patient.generalPractitioner 0..0 Patient's nominated primary care provider
Patient.managingOrganization This element must be supported. 0..1 Reference(Service Provider) Organization that is the custodian of the patient record
Patient.Slices for link This element must be supported. 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
Slice: Unordered, Open by value:other.display
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for link.link:PatientData This element must be supported. 0..1 BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
Patient.Slices for link.link:PatientData.other
Patient.Slices for link.link:PatientData.other.reference 1..1 string Literal reference, Relative, internal or absolute URL
Patient.Slices for link.link:PatientData.other.display 1..1 string Text alternative for the resource
Required Pattern: Patient data provided by Client Registry
Patient.Slices for link.link:PatientData.type 1..1 code replaced-by | replaces | refer | seealso
Required Pattern: seealso

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.id This element is included in summaries. 0..1 id Must be the same ID as the patient resource that suppplied the personal data during creation
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Patient.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.contained This element must be supported. 0..1 Patient Contained patient data
Patient.extension 0..* Extension Additional content defined by implementations
Patient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element is included in summaries. 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:MasterPatientIndex This element is included in summaries. 1..* Identifier An identifier for this patient
Patient.Slices for identifier.identifier:MasterPatientIndex.id 0..1 id Unique id for inter-element referencing
Patient.Slices for identifier.identifier:MasterPatientIndex.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:MasterPatientIndex.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:MasterPatientIndex.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:MasterPatientIndex.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/mpi
Patient.Slices for identifier.identifier:MasterPatientIndex.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:MasterPatientIndex.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:MasterPatientIndex.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:MRN This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:MRN.id 0..1 id Unique id for inter-element referencing
Patient.Slices for identifier.identifier:MRN.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:MRN.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:MRN.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:MRN.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/mrn
Patient.Slices for identifier.identifier:MRN.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:MRN.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:MRN.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:Internal This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:Internal.id 0..1 id Unique id for inter-element referencing
Patient.Slices for identifier.identifier:Internal.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:Internal.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:Internal.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:Internal.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/internalid
Patient.Slices for identifier.identifier:Internal.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:Internal.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:Internal.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:PIMS This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PIMS.id 0..1 id Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PIMS.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:PIMS.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:PIMS.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:PIMS.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/pims
Patient.Slices for identifier.identifier:PIMS.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:PIMS.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:PIMS.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:OpenMRS This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:OpenMRS.id 0..1 id Unique id for inter-element referencing
Patient.Slices for identifier.identifier:OpenMRS.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:OpenMRS.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:OpenMRS.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:OpenMRS.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/openmrs
Patient.Slices for identifier.identifier:OpenMRS.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:OpenMRS.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:OpenMRS.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.managingOrganization This element must be supported. This element is included in summaries. 0..1 Reference(Service Provider) Organization that is the custodian of the patient record
Patient.Slices for link This element is a modifier element. This element must be supported. This element is included in summaries. 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
Slice: Unordered, Open by value:other.display

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for link.link:All Slices Content/Rules for all slices
Patient.Slices for link.link:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for link.link:All Slices.extension 0..* Extension Additional content defined by implementations
Patient.Slices for link.link:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for link.link:All Slices.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.Slices for link.link:All Slices.type This element is included in summaries. 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
Patient.Slices for link.link:PatientData This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
Patient.Slices for link.link:PatientData.id 0..1 string Unique id for inter-element referencing
Patient.Slices for link.link:PatientData.extension 0..* Extension Additional content defined by implementations
Patient.Slices for link.link:PatientData.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for link.link:PatientData.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.Slices for link.link:PatientData.other.id 0..1 id Unique id for inter-element referencing
Patient.Slices for link.link:PatientData.other.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for link.link:PatientData.other.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
Patient.Slices for link.link:PatientData.other.type This element is included in summaries. 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).
Patient.Slices for link.link:PatientData.other.identifier This element is included in summaries. C 0..1 Identifier Logical reference, when literal reference is not known
Patient.Slices for link.link:PatientData.other.display This element is included in summaries. C 1..1 string Text alternative for the resource
Required Pattern: Patient data provided by Client Registry
Patient.Slices for link.link:PatientData.type This element is included in summaries. 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base required All Languages 📍5.0.0 FHIR Std.
Patient.identifier:MasterPatientIndex.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:MasterPatientIndex.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Patient.identifier:MRN.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:MRN.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Patient.identifier:Internal.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:Internal.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Patient.identifier:PIMS.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:PIMS.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Patient.identifier:OpenMRS.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:OpenMRS.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📍5.0.0 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍5.0.0 FHIR Std.
Patient.communication.​language Base required All Languages 📍5.0.0 FHIR Std.
Patient.link.type Base required Link Type 📍5.0.0 FHIR Std.
Patient.link:PatientData.​other.type Base extensible Resource Types 📍5.0.0 FHIR Std.
Patient.link:PatientData.​type Base required Link Type 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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:

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.id This element is included in summaries. 0..1 id Must be the same ID as the patient resource that suppplied the personal data during creation
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.contained This element must be supported. 0..1 Patient Contained patient data
Patient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element is included in summaries. 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:MasterPatientIndex This element is included in summaries. 1..* Identifier An identifier for this patient
Patient.Slices for identifier.identifier:MasterPatientIndex.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:MasterPatientIndex.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/mpi
Patient.Slices for identifier.identifier:MasterPatientIndex.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:MRN This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:MRN.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:MRN.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/mrn
Patient.Slices for identifier.identifier:MRN.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:Internal This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:Internal.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:Internal.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/internalid
Patient.Slices for identifier.identifier:Internal.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:PIMS This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PIMS.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:PIMS.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/pims
Patient.Slices for identifier.identifier:PIMS.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:OpenMRS This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:OpenMRS.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:OpenMRS.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/openmrs
Patient.Slices for identifier.identifier:OpenMRS.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.managingOrganization This element must be supported. This element is included in summaries. 0..1 Reference(Service Provider) Organization that is the custodian of the patient record
Patient.Slices for link This element is a modifier element. This element must be supported. This element is included in summaries. 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
Slice: Unordered, Open by value:other.display

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for link.link:All Slices Content/Rules for all slices
Patient.Slices for link.link:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for link.link:All Slices.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.Slices for link.link:All Slices.type This element is included in summaries. 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
Patient.Slices for link.link:PatientData This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
Patient.Slices for link.link:PatientData.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for link.link:PatientData.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.Slices for link.link:PatientData.other.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
Patient.Slices for link.link:PatientData.other.display This element is included in summaries. C 1..1 string Text alternative for the resource
Required Pattern: Patient data provided by Client Registry
Patient.Slices for link.link:PatientData.type This element is included in summaries. 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier:MasterPatientIndex.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:MRN.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:Internal.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:PIMS.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:OpenMRS.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.communication.​language Base required All Languages 📍5.0.0 FHIR Std.
Patient.link.type Base required Link Type 📍5.0.0 FHIR Std.
Patient.link:PatientData.​type Base required Link Type 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.id 0..1 id Must be the same ID as the patient resource that suppplied the personal data during creation
Patient.contained This element must be supported. 0..1 Patient Contained patient data
Patient.Slices for identifier 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:MasterPatientIndex 1..* Identifier An identifier for this patient
Patient.Slices for identifier.identifier:MasterPatientIndex.system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/mpi
Patient.Slices for identifier.identifier:MasterPatientIndex.value 1..1 string The value that is unique
Patient.Slices for identifier.identifier:MRN This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:MRN.system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/mrn
Patient.Slices for identifier.identifier:MRN.value 1..1 string The value that is unique
Patient.Slices for identifier.identifier:Internal This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:Internal.system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/internalid
Patient.Slices for identifier.identifier:Internal.value 1..1 string The value that is unique
Patient.Slices for identifier.identifier:PIMS This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PIMS.system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/pims
Patient.Slices for identifier.identifier:PIMS.value 1..1 string The value that is unique
Patient.Slices for identifier.identifier:OpenMRS This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:OpenMRS.system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/openmrs
Patient.Slices for identifier.identifier:OpenMRS.value 1..1 string The value that is unique
Patient.active 0..0 Whether this patient's record is in active use
Patient.name 0..0 A name associated with the patient
Patient.telecom 0..0 A contact detail for the individual
Patient.gender 0..0 male | female | other | unknown
Patient.birthDate 0..0 The date of birth for the individual
Patient.deceased[x] 0..0 Indicates if the individual is deceased or not
Patient.address 0..0 An address for the individual
Patient.maritalStatus 0..0 Marital (civil) status of a patient
Patient.multipleBirth[x] 0..0 Whether patient is part of a multiple birth
Patient.photo 0..0 Image of the patient
Patient.contact 0..0 A contact party (e.g. guardian, partner, friend) for the patient
Patient.communication 0..0 A language which may be used to communicate with the patient about his or her health
Patient.generalPractitioner 0..0 Patient's nominated primary care provider
Patient.managingOrganization This element must be supported. 0..1 Reference(Service Provider) Organization that is the custodian of the patient record
Patient.Slices for link This element must be supported. 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
Slice: Unordered, Open by value:other.display
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for link.link:PatientData This element must be supported. 0..1 BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
Patient.Slices for link.link:PatientData.other
Patient.Slices for link.link:PatientData.other.reference 1..1 string Literal reference, Relative, internal or absolute URL
Patient.Slices for link.link:PatientData.other.display 1..1 string Text alternative for the resource
Required Pattern: Patient data provided by Client Registry
Patient.Slices for link.link:PatientData.type 1..1 code replaced-by | replaces | refer | seealso
Required Pattern: seealso

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.id This element is included in summaries. 0..1 id Must be the same ID as the patient resource that suppplied the personal data during creation
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Patient.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.contained This element must be supported. 0..1 Patient Contained patient data
Patient.extension 0..* Extension Additional content defined by implementations
Patient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element is included in summaries. 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:MasterPatientIndex This element is included in summaries. 1..* Identifier An identifier for this patient
Patient.Slices for identifier.identifier:MasterPatientIndex.id 0..1 id Unique id for inter-element referencing
Patient.Slices for identifier.identifier:MasterPatientIndex.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:MasterPatientIndex.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:MasterPatientIndex.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:MasterPatientIndex.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/mpi
Patient.Slices for identifier.identifier:MasterPatientIndex.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:MasterPatientIndex.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:MasterPatientIndex.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:MRN This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:MRN.id 0..1 id Unique id for inter-element referencing
Patient.Slices for identifier.identifier:MRN.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:MRN.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:MRN.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:MRN.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/mrn
Patient.Slices for identifier.identifier:MRN.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:MRN.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:MRN.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:Internal This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:Internal.id 0..1 id Unique id for inter-element referencing
Patient.Slices for identifier.identifier:Internal.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:Internal.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:Internal.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:Internal.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/internalid
Patient.Slices for identifier.identifier:Internal.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:Internal.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:Internal.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:PIMS This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PIMS.id 0..1 id Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PIMS.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:PIMS.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:PIMS.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:PIMS.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/pims
Patient.Slices for identifier.identifier:PIMS.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:PIMS.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:PIMS.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:OpenMRS This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:OpenMRS.id 0..1 id Unique id for inter-element referencing
Patient.Slices for identifier.identifier:OpenMRS.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:OpenMRS.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:OpenMRS.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:OpenMRS.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/openmrs
Patient.Slices for identifier.identifier:OpenMRS.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:OpenMRS.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:OpenMRS.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.managingOrganization This element must be supported. This element is included in summaries. 0..1 Reference(Service Provider) Organization that is the custodian of the patient record
Patient.Slices for link This element is a modifier element. This element must be supported. This element is included in summaries. 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
Slice: Unordered, Open by value:other.display

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for link.link:All Slices Content/Rules for all slices
Patient.Slices for link.link:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for link.link:All Slices.extension 0..* Extension Additional content defined by implementations
Patient.Slices for link.link:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for link.link:All Slices.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.Slices for link.link:All Slices.type This element is included in summaries. 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
Patient.Slices for link.link:PatientData This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
Patient.Slices for link.link:PatientData.id 0..1 string Unique id for inter-element referencing
Patient.Slices for link.link:PatientData.extension 0..* Extension Additional content defined by implementations
Patient.Slices for link.link:PatientData.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for link.link:PatientData.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.Slices for link.link:PatientData.other.id 0..1 id Unique id for inter-element referencing
Patient.Slices for link.link:PatientData.other.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for link.link:PatientData.other.reference This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
Patient.Slices for link.link:PatientData.other.type This element is included in summaries. 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).
Patient.Slices for link.link:PatientData.other.identifier This element is included in summaries. C 0..1 Identifier Logical reference, when literal reference is not known
Patient.Slices for link.link:PatientData.other.display This element is included in summaries. C 1..1 string Text alternative for the resource
Required Pattern: Patient data provided by Client Registry
Patient.Slices for link.link:PatientData.type This element is included in summaries. 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base required All Languages 📍5.0.0 FHIR Std.
Patient.identifier:MasterPatientIndex.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:MasterPatientIndex.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Patient.identifier:MRN.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:MRN.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Patient.identifier:Internal.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:Internal.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Patient.identifier:PIMS.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:PIMS.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Patient.identifier:OpenMRS.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:OpenMRS.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📍5.0.0 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍5.0.0 FHIR Std.
Patient.communication.​language Base required All Languages 📍5.0.0 FHIR Std.
Patient.link.type Base required Link Type 📍5.0.0 FHIR Std.
Patient.link:PatientData.​other.type Base extensible Resource Types 📍5.0.0 FHIR Std.
Patient.link:PatientData.​type Base required Link Type 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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:

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