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 2025-08-20 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: Filtersdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
Constraints: PatientIdentifier-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... identifier:MRN SΣ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/mrn
..... value ΣC 1..1 string The value that is unique
Example General: 123456
.... identifier:OMANG SΣ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/omang
..... value ΣC 1..1 string The value that is unique
Example General: 123456
.... identifier:Birth SΣ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/birth
..... value ΣC 1..1 string The value that is unique
Example General: 123456
.... identifier:Passport SΣ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/passport
..... value ΣC 1..1 string The value that is unique
Example General: 123456
.... identifier:Immigration SΣ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/immigration
..... value ΣC 1..1 string The value that is unique
Example General: 123456
.... identifier:Internal SΣ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/internalid
..... value ΣC 1..1 string The value that is unique
Example General: 123456
.... identifier:PIMS SΣ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/pims
..... value ΣC 1..1 string The value that is unique
Example General: 123456
.... identifier:OpenMRS SΣ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/openmrs
..... value ΣC 1..1 string The value that is unique
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name Σ 1..* HumanName A name associated with the patient
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family Σ 1..1 string Family name (often called 'Surname')
.... given Σ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... telecom SΣ 0..* ContactPoint A contact detail for the individual
... gender Σ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 1..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address An address for the individual
... managingOrganization SΣ 0..1 Reference(Service Provider) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.identifier:MRN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:OMANG.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:Birth.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:Passport.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:Immigration.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:Internal.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:PIMS.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:OpenMRS.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|5.0.0
From the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
From the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
PatientIdentifier-1errorPatientThe 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-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
Constraints: PatientIdentifier-1
... Slices for identifier 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:MRN S 0..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/mrn
..... value 1..1 string The value that is unique
.... identifier:OMANG S 0..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/omang
..... value 1..1 string The value that is unique
.... identifier:Birth S 0..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/birth
..... value 1..1 string The value that is unique
.... identifier:Passport S 0..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/passport
..... value 1..1 string The value that is unique
.... identifier:Immigration S 0..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/immigration
..... value 1..1 string The value that is unique
.... identifier:Internal S 0..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/internalid
..... value 1..1 string The value that is unique
.... identifier:PIMS S 0..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/pims
..... value 1..1 string The value that is unique
.... identifier:OpenMRS S 0..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/openmrs
..... value 1..1 string The value that is unique
... name 1..* HumanName A name associated with the patient
.... family 1..1 string Family name (often called 'Surname')
.... given 1..* string Given names (not always 'first'). Includes middle names
... telecom S 0..* ContactPoint A contact detail for the individual
... birthDate 1..1 date The date of birth for the individual
... address S 0..* Address An address for the individual
... managingOrganization S 0..1 Reference(Service Provider) Organization that is the custodian of the patient record

doco Documentation for this format

Constraints

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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
Patient.identifier:MRN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:MRN.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Patient.identifier:OMANG.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:OMANG.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Patient.identifier:Birth.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:Birth.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Patient.identifier:Passport.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:Passport.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Patient.identifier:Immigration.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:Immigration.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Patient.identifier:Internal.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:Internal.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Patient.identifier:PIMS.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:PIMS.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Patient.identifier:OpenMRS.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:OpenMRS.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|5.0.0
From the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
From the FHIR Standard
Patient.maritalStatusextensibleMaritalStatusCodes
http://hl7.org/fhir/ValueSet/marital-status
From the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
From the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
From the FHIR Standard
Patient.communication.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
PatientIdentifier-1errorPatientThe 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-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL 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: Filtersdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
Constraints: PatientIdentifier-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... identifier:MRN SΣ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/mrn
..... value ΣC 1..1 string The value that is unique
Example General: 123456
.... identifier:OMANG SΣ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/omang
..... value ΣC 1..1 string The value that is unique
Example General: 123456
.... identifier:Birth SΣ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/birth
..... value ΣC 1..1 string The value that is unique
Example General: 123456
.... identifier:Passport SΣ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/passport
..... value ΣC 1..1 string The value that is unique
Example General: 123456
.... identifier:Immigration SΣ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/immigration
..... value ΣC 1..1 string The value that is unique
Example General: 123456
.... identifier:Internal SΣ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/internalid
..... value ΣC 1..1 string The value that is unique
Example General: 123456
.... identifier:PIMS SΣ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/pims
..... value ΣC 1..1 string The value that is unique
Example General: 123456
.... identifier:OpenMRS SΣ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/openmrs
..... value ΣC 1..1 string The value that is unique
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name Σ 1..* HumanName A name associated with the patient
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family Σ 1..1 string Family name (often called 'Surname')
.... given Σ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... telecom SΣ 0..* ContactPoint A contact detail for the individual
... gender Σ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 1..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address An address for the individual
... managingOrganization SΣ 0..1 Reference(Service Provider) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.identifier:MRN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:OMANG.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:Birth.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:Passport.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:Immigration.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:Internal.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:PIMS.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:OpenMRS.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|5.0.0
From the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
From the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
PatientIdentifier-1errorPatientThe 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-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
Constraints: PatientIdentifier-1
... Slices for identifier 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:MRN S 0..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/mrn
..... value 1..1 string The value that is unique
.... identifier:OMANG S 0..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/omang
..... value 1..1 string The value that is unique
.... identifier:Birth S 0..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/birth
..... value 1..1 string The value that is unique
.... identifier:Passport S 0..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/passport
..... value 1..1 string The value that is unique
.... identifier:Immigration S 0..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/immigration
..... value 1..1 string The value that is unique
.... identifier:Internal S 0..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/internalid
..... value 1..1 string The value that is unique
.... identifier:PIMS S 0..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/pims
..... value 1..1 string The value that is unique
.... identifier:OpenMRS S 0..1 Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.bw.org/identifier/openmrs
..... value 1..1 string The value that is unique
... name 1..* HumanName A name associated with the patient
.... family 1..1 string Family name (often called 'Surname')
.... given 1..* string Given names (not always 'first'). Includes middle names
... telecom S 0..* ContactPoint A contact detail for the individual
... birthDate 1..1 date The date of birth for the individual
... address S 0..* Address An address for the individual
... managingOrganization S 0..1 Reference(Service Provider) Organization that is the custodian of the patient record

doco Documentation for this format

Constraints

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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
Patient.identifier:MRN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:MRN.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Patient.identifier:OMANG.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:OMANG.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Patient.identifier:Birth.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:Birth.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Patient.identifier:Passport.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:Passport.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Patient.identifier:Immigration.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:Immigration.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Patient.identifier:Internal.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:Internal.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Patient.identifier:PIMS.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:PIMS.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Patient.identifier:OpenMRS.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Patient.identifier:OpenMRS.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|5.0.0
From the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
From the FHIR Standard
Patient.maritalStatusextensibleMaritalStatusCodes
http://hl7.org/fhir/ValueSet/marital-status
From the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
From the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
From the FHIR Standard
Patient.communication.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
PatientIdentifier-1errorPatientThe 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-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL 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