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 - Botswana Patient

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

Is used to document demographics and other personal information about an individual receiving care or other health-related services.

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 C 0..* Patient Information about an individual or animal receiving health care services
Constraints: PatientIdentifier-1
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 0..* Resource Contained, inline Resources
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: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:OMANG This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:OMANG.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:OMANG.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/omang
Patient.Slices for identifier.identifier:OMANG.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:Birth This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:Birth.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:Birth.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/birth
Patient.Slices for identifier.identifier:Birth.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:Passport This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:Passport.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:Passport.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/passport
Patient.Slices for identifier.identifier:Passport.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:Immigration This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:Immigration.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:Immigration.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/immigration
Patient.Slices for identifier.identifier:Immigration.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.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element is included in summaries. 1..* HumanName A name associated with the patient
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.family This element is included in summaries. 1..1 string Family name (often called 'Surname')
Patient.name.given This element is included in summaries. 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.telecom This element must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Patient.gender This element is included in summaries. 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 1..1 date The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element must be supported. This element is included in summaries. 0..* Address An address for the individual
Patient.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.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.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.link.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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier:MRN.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:OMANG.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:Birth.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:Passport.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:Immigration.​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.name.use Base required NameUse 📍5.0.0 FHIR Std.
Patient.gender Base required AdministrativeGender 📍5.0.0 FHIR Std.
Patient.link.type Base required Link Type 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
PatientIdentifier-1 error Patient The Patient profile SHALL have at least one identifier "PIMS" or "OpenMRS". identifier.slice('http://moh.bw.org/StructureDefinition/bw-patient', 'PIMS').count() + identifier.slice('http://moh.bw.org/StructureDefinition/bw-patient', 'OpenMRS').count() > 0
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 C 0..* Patient Information about an individual or animal receiving health care services
Constraints: PatientIdentifier-1
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: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:OMANG This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:OMANG.system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/omang
Patient.Slices for identifier.identifier:OMANG.value 1..1 string The value that is unique
Patient.Slices for identifier.identifier:Birth This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:Birth.system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/birth
Patient.Slices for identifier.identifier:Birth.value 1..1 string The value that is unique
Patient.Slices for identifier.identifier:Passport This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:Passport.system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/passport
Patient.Slices for identifier.identifier:Passport.value 1..1 string The value that is unique
Patient.Slices for identifier.identifier:Immigration This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:Immigration.system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/immigration
Patient.Slices for identifier.identifier:Immigration.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 1..* HumanName A name associated with the patient
Patient.name.family 1..1 string Family name (often called 'Surname')
Patient.name.given 1..* string Given names (not always 'first'). Includes middle names
Patient.telecom This element must be supported. 0..* ContactPoint A contact detail for the individual
Patient.birthDate 1..1 date The date of birth for the individual
Patient.address This element must be supported. 0..* Address An address for the individual
Patient.managingOrganization This element must be supported. 0..1 Reference(Service Provider) Organization that is the custodian of the patient record

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
PatientIdentifier-1 error Patient The Patient profile SHALL have at least one identifier "PIMS" or "OpenMRS". identifier.slice('http://moh.bw.org/StructureDefinition/bw-patient', 'PIMS').count() + identifier.slice('http://moh.bw.org/StructureDefinition/bw-patient', 'OpenMRS').count() > 0
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* Patient Information about an individual or animal receiving health care services
Constraints: PatientIdentifier-1
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.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 0..* Resource Contained, inline Resources
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: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:OMANG This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:OMANG.id 0..1 id Unique id for inter-element referencing
Patient.Slices for identifier.identifier:OMANG.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:OMANG.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:OMANG.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:OMANG.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/omang
Patient.Slices for identifier.identifier:OMANG.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:OMANG.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:OMANG.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:Birth This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:Birth.id 0..1 id Unique id for inter-element referencing
Patient.Slices for identifier.identifier:Birth.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:Birth.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:Birth.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:Birth.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/birth
Patient.Slices for identifier.identifier:Birth.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:Birth.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:Birth.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:Passport This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:Passport.id 0..1 id Unique id for inter-element referencing
Patient.Slices for identifier.identifier:Passport.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:Passport.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:Passport.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:Passport.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/passport
Patient.Slices for identifier.identifier:Passport.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:Passport.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:Passport.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:Immigration This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:Immigration.id 0..1 id Unique id for inter-element referencing
Patient.Slices for identifier.identifier:Immigration.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:Immigration.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:Immigration.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:Immigration.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/immigration
Patient.Slices for identifier.identifier:Immigration.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:Immigration.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:Immigration.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.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element is included in summaries. 1..* HumanName A name associated with the patient
Patient.name.id 0..1 id Unique id for inter-element referencing
Patient.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.name.family This element is included in summaries. 1..1 string Family name (often called 'Surname')
Patient.name.given This element is included in summaries. 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Patient.telecom This element must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Patient.gender This element is included in summaries. 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 1..1 date The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element must be supported. This element is included in summaries. 0..* Address An address for the individual
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x] 0..1 Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean boolean
Patient.multipleBirth[x].multipleBirthInteger integer
Patient.photo 0..* Attachment Image of the patient
Patient.contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
Patient.contact.id 0..1 string Unique id for inter-element referencing
Patient.contact.extension 0..* Extension Additional content defined by implementations
Patient.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name C 0..1 HumanName A name associated with the contact person
Patient.contact.telecom C 0..* ContactPoint A contact detail for the person
Patient.contact.address C 0..1 Address Address for the contact person
Patient.contact.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.contact.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
Patient.communication.id 0..1 string Unique id for inter-element referencing
Patient.communication.extension 0..* Extension Additional content defined by implementations
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Patient.communication.preferred 0..1 boolean Language preference indicator
Patient.generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element must be supported. This element is included in summaries. 0..1 Reference(Service Provider) Organization that is the custodian of the patient record
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
Patient.link.id 0..1 string Unique id for inter-element referencing
Patient.link.extension 0..* Extension Additional content defined by implementations
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.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.link.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

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: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:OMANG.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:OMANG.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Patient.identifier:Birth.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:Birth.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Patient.identifier:Passport.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:Passport.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Patient.identifier:Immigration.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:Immigration.​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.name.use Base required NameUse 📍5.0.0 FHIR Std.
Patient.gender Base required AdministrativeGender 📍5.0.0 FHIR Std.
Patient.maritalStatus Base extensible Marital Status 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.

Constraints

Id Grade Path(s) Description Expression
PatientIdentifier-1 error Patient The Patient profile SHALL have at least one identifier "PIMS" or "OpenMRS". identifier.slice('http://moh.bw.org/StructureDefinition/bw-patient', 'PIMS').count() + identifier.slice('http://moh.bw.org/StructureDefinition/bw-patient', 'OpenMRS').count() > 0
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pat-1 error Patient.contact SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from Patient

Summary

Mandatory: 6 elements(16 nested mandatory elements)
Must-Support: 11 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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* Patient Information about an individual or animal receiving health care services
Constraints: PatientIdentifier-1
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 0..* Resource Contained, inline Resources
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: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:OMANG This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:OMANG.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:OMANG.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/omang
Patient.Slices for identifier.identifier:OMANG.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:Birth This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:Birth.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:Birth.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/birth
Patient.Slices for identifier.identifier:Birth.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:Passport This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:Passport.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:Passport.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/passport
Patient.Slices for identifier.identifier:Passport.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:Immigration This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:Immigration.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:Immigration.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/immigration
Patient.Slices for identifier.identifier:Immigration.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.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element is included in summaries. 1..* HumanName A name associated with the patient
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.family This element is included in summaries. 1..1 string Family name (often called 'Surname')
Patient.name.given This element is included in summaries. 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.telecom This element must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Patient.gender This element is included in summaries. 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 1..1 date The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element must be supported. This element is included in summaries. 0..* Address An address for the individual
Patient.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.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.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.link.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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier:MRN.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:OMANG.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:Birth.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:Passport.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:Immigration.​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.name.use Base required NameUse 📍5.0.0 FHIR Std.
Patient.gender Base required AdministrativeGender 📍5.0.0 FHIR Std.
Patient.link.type Base required Link Type 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
PatientIdentifier-1 error Patient The Patient profile SHALL have at least one identifier "PIMS" or "OpenMRS". identifier.slice('http://moh.bw.org/StructureDefinition/bw-patient', 'PIMS').count() + identifier.slice('http://moh.bw.org/StructureDefinition/bw-patient', 'OpenMRS').count() > 0
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 C 0..* Patient Information about an individual or animal receiving health care services
Constraints: PatientIdentifier-1
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: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:OMANG This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:OMANG.system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/omang
Patient.Slices for identifier.identifier:OMANG.value 1..1 string The value that is unique
Patient.Slices for identifier.identifier:Birth This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:Birth.system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/birth
Patient.Slices for identifier.identifier:Birth.value 1..1 string The value that is unique
Patient.Slices for identifier.identifier:Passport This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:Passport.system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/passport
Patient.Slices for identifier.identifier:Passport.value 1..1 string The value that is unique
Patient.Slices for identifier.identifier:Immigration This element must be supported. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:Immigration.system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/immigration
Patient.Slices for identifier.identifier:Immigration.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 1..* HumanName A name associated with the patient
Patient.name.family 1..1 string Family name (often called 'Surname')
Patient.name.given 1..* string Given names (not always 'first'). Includes middle names
Patient.telecom This element must be supported. 0..* ContactPoint A contact detail for the individual
Patient.gender 1..1 code male | female | other | unknown
Patient.birthDate 1..1 date The date of birth for the individual
Patient.address This element must be supported. 0..* Address An address for the individual
Patient.managingOrganization This element must be supported. 0..1 Reference(Service Provider) Organization that is the custodian of the patient record

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
PatientIdentifier-1 error Patient The Patient profile SHALL have at least one identifier "PIMS" or "OpenMRS". identifier.slice('http://moh.bw.org/StructureDefinition/bw-patient', 'PIMS').count() + identifier.slice('http://moh.bw.org/StructureDefinition/bw-patient', 'OpenMRS').count() > 0

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* Patient Information about an individual or animal receiving health care services
Constraints: PatientIdentifier-1
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.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 0..* Resource Contained, inline Resources
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: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:OMANG This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:OMANG.id 0..1 id Unique id for inter-element referencing
Patient.Slices for identifier.identifier:OMANG.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:OMANG.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:OMANG.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:OMANG.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/omang
Patient.Slices for identifier.identifier:OMANG.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:OMANG.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:OMANG.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:Birth This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:Birth.id 0..1 id Unique id for inter-element referencing
Patient.Slices for identifier.identifier:Birth.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:Birth.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:Birth.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:Birth.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/birth
Patient.Slices for identifier.identifier:Birth.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:Birth.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:Birth.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:Passport This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:Passport.id 0..1 id Unique id for inter-element referencing
Patient.Slices for identifier.identifier:Passport.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:Passport.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:Passport.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:Passport.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/passport
Patient.Slices for identifier.identifier:Passport.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:Passport.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:Passport.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:Immigration This element must be supported. This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:Immigration.id 0..1 id Unique id for inter-element referencing
Patient.Slices for identifier.identifier:Immigration.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:Immigration.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:Immigration.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:Immigration.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/immigration
Patient.Slices for identifier.identifier:Immigration.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:Immigration.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:Immigration.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.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element is included in summaries. 1..* HumanName A name associated with the patient
Patient.name.id 0..1 id Unique id for inter-element referencing
Patient.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.name.family This element is included in summaries. 1..1 string Family name (often called 'Surname')
Patient.name.given This element is included in summaries. 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Patient.telecom This element must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Patient.gender This element is included in summaries. 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 1..1 date The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element must be supported. This element is included in summaries. 0..* Address An address for the individual
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x] 0..1 Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean boolean
Patient.multipleBirth[x].multipleBirthInteger integer
Patient.photo 0..* Attachment Image of the patient
Patient.contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
Patient.contact.id 0..1 string Unique id for inter-element referencing
Patient.contact.extension 0..* Extension Additional content defined by implementations
Patient.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name C 0..1 HumanName A name associated with the contact person
Patient.contact.telecom C 0..* ContactPoint A contact detail for the person
Patient.contact.address C 0..1 Address Address for the contact person
Patient.contact.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.contact.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
Patient.communication.id 0..1 string Unique id for inter-element referencing
Patient.communication.extension 0..* Extension Additional content defined by implementations
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Patient.communication.preferred 0..1 boolean Language preference indicator
Patient.generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element must be supported. This element is included in summaries. 0..1 Reference(Service Provider) Organization that is the custodian of the patient record
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
Patient.link.id 0..1 string Unique id for inter-element referencing
Patient.link.extension 0..* Extension Additional content defined by implementations
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.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.link.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

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: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:OMANG.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:OMANG.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Patient.identifier:Birth.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:Birth.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Patient.identifier:Passport.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:Passport.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Patient.identifier:Immigration.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier:Immigration.​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.name.use Base required NameUse 📍5.0.0 FHIR Std.
Patient.gender Base required AdministrativeGender 📍5.0.0 FHIR Std.
Patient.maritalStatus Base extensible Marital Status 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.

Constraints

Id Grade Path(s) Description Expression
PatientIdentifier-1 error Patient The Patient profile SHALL have at least one identifier "PIMS" or "OpenMRS". identifier.slice('http://moh.bw.org/StructureDefinition/bw-patient', 'PIMS').count() + identifier.slice('http://moh.bw.org/StructureDefinition/bw-patient', 'OpenMRS').count() > 0
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pat-1 error Patient.contact SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from Patient

Summary

Mandatory: 6 elements(16 nested mandatory elements)
Must-Support: 11 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

 

Other representations of profile: CSV, Excel, Schematron