Healthcare Financial Services IG Edition 1
0.4.0 - STU-Ballot with Updates Saudi Arabia flag

Healthcare Financial Services IG Edition 1 - Local Development build (v0.4.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Nphies Patient

Official URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/patient Version: 0.4.0
Draft as of 2025-10-12 Computable Name: NphiesPatient

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

Patient Profile

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: BV-00339, BV-00848
... id Σ 1..1 id Logical id of this artifact
Max Length:64
... meta Σ 1..1 Meta Metadata about the resource
.... profile Σ 1..* DP_canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
.... extension:patient-religion S 0..1 DP_CodeableConcept Patient Religion
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-patient-religion
Binding: Religion (required)
.... extension:occupation C 1..1 DP_CodeableConcept Patient Occupation
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-occupation
Binding: Occupation (required)
Constraints: DT-01542, IC-01561
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* DP_Identifier_B An identifier for this patient
Slice: Unordered, Closed by value:type
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..1 DP_CodeableConcept Description of identifier
Binding: Patient Identifier Type (required)
..... system Σ 1..1 DP_uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
Max Length:50
.... identifier:iqama ΣC 0..1 Identifier Saudi Resident Id (Iqama)
Constraints: BV-00798
..... 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: Patient Identifier Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRC
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
.... identifier:passport ΣC 0..1 Identifier Passport Number
Constraints: BV-00481
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:country 1..1 DP_CodeableConcept Patient Identifier Country
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-identifier-country
Binding: Iso3166-1-3 (required)
..... 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: Patient Identifier Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
.... identifier:nationalid ΣC 0..1 Identifier National Identifier
Constraints: BV-00797
..... 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: Patient Identifier Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NI
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
.... identifier:visa Σ 0..1 Identifier Visa Number
..... 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: Patient Identifier Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: VP
....... display 1..1 string Representation defined by the system
Fixed Value: Visitor Permit
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
.... identifier:medicalrecord Σ 0..1 Identifier Medical Record Number
..... 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: Patient Identifier Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
... active ?!Σ 1..1 boolean Whether this patient's record is in active use
... name Σ 1..1 DP_HumanName A name associated with the patient
... telecom SΣ 0..1 ContactPoint A contact detail for the individual
... gender Σ 1..1 DP_code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:ksa-administrative-gender 1..1 DP_CodeableConcept Administrative Gender
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-ksa-administrative-gender
Binding: KSA Administrative Gender (required)
.... value 0..1 string Primitive value for code
Max Length:30
... birthDate Σ 1..1 DP_date The date of birth for the individual
... Slices for deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedBoolean ?!SΣ 0..1 boolean Indicates if the individual is deceased or not
.... deceased[x]:deceasedDateTime ?!SΣ 0..1 DP_dateTime Indicates if the individual is deceased or not
... address SΣ 0..1 DP_Address An address for the individual
... maritalStatus 1..1 DP_CodeableConcept Marital (civil) status of a patient
Binding: KSA Marital Status (required)
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.identifier:iqama.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:iqama.​type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.identifier:passport.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:passport.​type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.identifier:nationalid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:nationalid.​type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.identifier:visa.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:visa.​type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.identifier:medicalrecord.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:medicalrecord.​type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.maritalStatus Base required KSA Marital Status 📦0.4.0 This IG
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
BV-00339 error Patient Patient active is not using the specified value 'true' active.exists() and active = true
BV-00481 error Patient.identifier:passport Patient's passport issuing country is not provided extension('http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-identifier-country').exists()
BV-00797 error Patient.identifier:nationalid Patient Identifier shall consist of 10 digits starting with 2 when National ID used value.substring(0,1) = '1' and value.length() = 10
BV-00798 error Patient.identifier:iqama Patient Identifier shall consist of 10 digits starting with 2 when Iqama ID used value.substring(0,1) = '2' and value.length() = 10
BV-00848 error Patient Patient Birthdate Shall not be more than currentDate or before 1st Jan 1900 birthDate >= @1900-01-01 and birthDate <= today()
DT-01542 error Patient.extension:occupation Invalid data type used for Patient extension occupation. value.exists() implies value is CodeableConcept
IC-01561 error Patient.extension:occupation Patient extension occupation is not following the specified cardinality within the message profile. value.exists() implies value.count() = 1
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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: Filtersdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
Constraints: BV-00339, BV-00848
... id 1..1 id Logical id of this artifact
Max Length:64
... meta 1..1 Meta Metadata about the resource
.... profile 1..* DP_canonical(StructureDefinition) Profiles this resource claims to conform to
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:patient-religion S 0..1 DP_CodeableConcept Patient Religion
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-patient-religion
Binding: Religion (required)
.... extension:occupation 1..1 DP_CodeableConcept Patient Occupation
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-occupation
Binding: Occupation (required)
.... identifier:All Slices Content/Rules for all slices
..... type 1..1 DP_CodeableConcept Description of identifier
Binding: Patient Identifier Type (required)
.... identifier:iqama C 0..1 Identifier Saudi Resident Id (Iqama)
Constraints: BV-00798
..... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRC
.... identifier:passport C 0..1 Identifier Passport Number
Constraints: BV-00481
..... extension 1..* Extension Extension
..... Slices for extension Content/Rules for all slices
...... extension:country 1..1 DP_CodeableConcept Patient Identifier Country
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-identifier-country
Binding: Iso3166-1-3 (required)
..... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
.... identifier:nationalid C 0..1 Identifier National Identifier
Constraints: BV-00797
..... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NI
.... identifier:visa 0..1 Identifier Visa Number
..... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: VP
....... display 1..1 string Representation defined by the system
Fixed Value: Visitor Permit
.... identifier:medicalrecord 0..1 Identifier Medical Record Number
..... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
... active 1..1 boolean Whether this patient's record is in active use
... name 1..1 DP_HumanName A name associated with the patient
... telecom S 0..1 ContactPoint A contact detail for the individual
... gender 1..1 DP_code male | female | other | unknown
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:ksa-administrative-gender 1..1 DP_CodeableConcept Administrative Gender
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-ksa-administrative-gender
Binding: KSA Administrative Gender (required)
... birthDate 1..1 DP_date The date of birth for the individual
... Slices for deceased[x] S 0..1 boolean, dateTime Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceased[x]:deceasedBoolean S 0..1 boolean Indicates if the individual is deceased or not
.... deceased[x]:deceasedDateTime S 0..1 DP_dateTime Indicates if the individual is deceased or not
... address S 0..1 DP_Address An address for the individual
... maritalStatus 1..1 DP_CodeableConcept Marital (civil) status of a patient
Binding: KSA Marital Status (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.identifier.type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.maritalStatus Base required KSA Marital Status 📦0.4.0 This IG

Constraints

Id Grade Path(s) Description Expression
BV-00339 error Patient Patient active is not using the specified value 'true' active.exists() and active = true
BV-00481 error Patient.identifier:passport Patient's passport issuing country is not provided extension('http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-identifier-country').exists()
BV-00797 error Patient.identifier:nationalid Patient Identifier shall consist of 10 digits starting with 2 when National ID used value.substring(0,1) = '1' and value.length() = 10
BV-00798 error Patient.identifier:iqama Patient Identifier shall consist of 10 digits starting with 2 when Iqama ID used value.substring(0,1) = '2' and value.length() = 10
BV-00848 error Patient Patient Birthdate Shall not be more than currentDate or before 1st Jan 1900 birthDate >= @1900-01-01 and birthDate <= today()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
Constraints: BV-00339, BV-00848
... id Σ 1..1 id Logical id of this artifact
Max Length:64
... meta Σ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* DP_canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... 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
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:patient-religion S 0..1 DP_CodeableConcept Patient Religion
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-patient-religion
Binding: Religion (required)
.... extension:occupation C 1..1 DP_CodeableConcept Patient Occupation
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-occupation
Binding: Occupation (required)
Constraints: DT-01542, IC-01561
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* DP_Identifier_B An identifier for this patient
Slice: Unordered, Closed by value:type
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
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 Σ 1..1 DP_CodeableConcept Description of identifier
Binding: Patient Identifier Type (required)
..... system Σ 1..1 DP_uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
Max Length:50
..... 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:iqama ΣC 0..1 Identifier Saudi Resident Id (Iqama)
Constraints: BV-00798
..... id 0..1 string 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: Patient Identifier Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRC
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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 ΣC 0..1 Identifier Passport Number
Constraints: BV-00481
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:country 1..1 DP_CodeableConcept Patient Identifier Country
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-identifier-country
Binding: Iso3166-1-3 (required)
..... 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: Patient Identifier Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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:nationalid ΣC 0..1 Identifier National Identifier
Constraints: BV-00797
..... id 0..1 string 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: Patient Identifier Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NI
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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:visa Σ 0..1 Identifier Visa Number
..... id 0..1 string 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: Patient Identifier Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: VP
....... display 1..1 string Representation defined by the system
Fixed Value: Visitor Permit
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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:medicalrecord Σ 0..1 Identifier Medical Record Number
..... id 0..1 string 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: Patient Identifier Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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 ?!Σ 1..1 boolean Whether this patient's record is in active use
... name Σ 1..1 DP_HumanName A name associated with the patient
... telecom SΣ 0..1 ContactPoint A contact detail for the individual
... gender Σ 1..1 DP_code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:ksa-administrative-gender 1..1 DP_CodeableConcept Administrative Gender
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-ksa-administrative-gender
Binding: KSA Administrative Gender (required)
.... value 0..1 string Primitive value for code
Max Length:30
... birthDate Σ 1..1 DP_date The date of birth for the individual
... Slices for deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedBoolean ?!SΣ 0..1 boolean Indicates if the individual is deceased or not
.... deceased[x]:deceasedDateTime ?!SΣ 0..1 DP_dateTime Indicates if the individual is deceased or not
... address SΣ 0..1 DP_Address An address for the individual
... maritalStatus 1..1 DP_CodeableConcept Marital (civil) status of a patient
Binding: KSA Marital Status (required)
... 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 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 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: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Patient.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.identifier:iqama.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:iqama.​type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.identifier:passport.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:passport.​type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.identifier:nationalid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:nationalid.​type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.identifier:visa.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:visa.​type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.identifier:medicalrecord.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:medicalrecord.​type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.maritalStatus Base required KSA Marital Status 📦0.4.0 This IG
Patient.contact.relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
BV-00339 error Patient Patient active is not using the specified value 'true' active.exists() and active = true
BV-00481 error Patient.identifier:passport Patient's passport issuing country is not provided extension('http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-identifier-country').exists()
BV-00797 error Patient.identifier:nationalid Patient Identifier shall consist of 10 digits starting with 2 when National ID used value.substring(0,1) = '1' and value.length() = 10
BV-00798 error Patient.identifier:iqama Patient Identifier shall consist of 10 digits starting with 2 when Iqama ID used value.substring(0,1) = '2' and value.length() = 10
BV-00848 error Patient Patient Birthdate Shall not be more than currentDate or before 1st Jan 1900 birthDate >= @1900-01-01 and birthDate <= today()
DT-01542 error Patient.extension:occupation Invalid data type used for Patient extension occupation. value.exists() implies value is CodeableConcept
IC-01561 error Patient.extension:occupation Patient extension occupation is not following the specified cardinality within the message profile. value.exists() implies value.count() = 1
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
Constraints: BV-00339, BV-00848
... id Σ 1..1 id Logical id of this artifact
Max Length:64
... meta Σ 1..1 Meta Metadata about the resource
.... profile Σ 1..* DP_canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
.... extension:patient-religion S 0..1 DP_CodeableConcept Patient Religion
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-patient-religion
Binding: Religion (required)
.... extension:occupation C 1..1 DP_CodeableConcept Patient Occupation
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-occupation
Binding: Occupation (required)
Constraints: DT-01542, IC-01561
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* DP_Identifier_B An identifier for this patient
Slice: Unordered, Closed by value:type
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..1 DP_CodeableConcept Description of identifier
Binding: Patient Identifier Type (required)
..... system Σ 1..1 DP_uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
Max Length:50
.... identifier:iqama ΣC 0..1 Identifier Saudi Resident Id (Iqama)
Constraints: BV-00798
..... 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: Patient Identifier Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRC
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
.... identifier:passport ΣC 0..1 Identifier Passport Number
Constraints: BV-00481
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:country 1..1 DP_CodeableConcept Patient Identifier Country
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-identifier-country
Binding: Iso3166-1-3 (required)
..... 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: Patient Identifier Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
.... identifier:nationalid ΣC 0..1 Identifier National Identifier
Constraints: BV-00797
..... 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: Patient Identifier Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NI
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
.... identifier:visa Σ 0..1 Identifier Visa Number
..... 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: Patient Identifier Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: VP
....... display 1..1 string Representation defined by the system
Fixed Value: Visitor Permit
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
.... identifier:medicalrecord Σ 0..1 Identifier Medical Record Number
..... 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: Patient Identifier Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
... active ?!Σ 1..1 boolean Whether this patient's record is in active use
... name Σ 1..1 DP_HumanName A name associated with the patient
... telecom SΣ 0..1 ContactPoint A contact detail for the individual
... gender Σ 1..1 DP_code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:ksa-administrative-gender 1..1 DP_CodeableConcept Administrative Gender
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-ksa-administrative-gender
Binding: KSA Administrative Gender (required)
.... value 0..1 string Primitive value for code
Max Length:30
... birthDate Σ 1..1 DP_date The date of birth for the individual
... Slices for deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedBoolean ?!SΣ 0..1 boolean Indicates if the individual is deceased or not
.... deceased[x]:deceasedDateTime ?!SΣ 0..1 DP_dateTime Indicates if the individual is deceased or not
... address SΣ 0..1 DP_Address An address for the individual
... maritalStatus 1..1 DP_CodeableConcept Marital (civil) status of a patient
Binding: KSA Marital Status (required)
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.identifier:iqama.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:iqama.​type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.identifier:passport.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:passport.​type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.identifier:nationalid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:nationalid.​type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.identifier:visa.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:visa.​type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.identifier:medicalrecord.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:medicalrecord.​type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.maritalStatus Base required KSA Marital Status 📦0.4.0 This IG
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
BV-00339 error Patient Patient active is not using the specified value 'true' active.exists() and active = true
BV-00481 error Patient.identifier:passport Patient's passport issuing country is not provided extension('http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-identifier-country').exists()
BV-00797 error Patient.identifier:nationalid Patient Identifier shall consist of 10 digits starting with 2 when National ID used value.substring(0,1) = '1' and value.length() = 10
BV-00798 error Patient.identifier:iqama Patient Identifier shall consist of 10 digits starting with 2 when Iqama ID used value.substring(0,1) = '2' and value.length() = 10
BV-00848 error Patient Patient Birthdate Shall not be more than currentDate or before 1st Jan 1900 birthDate >= @1900-01-01 and birthDate <= today()
DT-01542 error Patient.extension:occupation Invalid data type used for Patient extension occupation. value.exists() implies value is CodeableConcept
IC-01561 error Patient.extension:occupation Patient extension occupation is not following the specified cardinality within the message profile. value.exists() implies value.count() = 1
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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: Filtersdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
Constraints: BV-00339, BV-00848
... id 1..1 id Logical id of this artifact
Max Length:64
... meta 1..1 Meta Metadata about the resource
.... profile 1..* DP_canonical(StructureDefinition) Profiles this resource claims to conform to
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:patient-religion S 0..1 DP_CodeableConcept Patient Religion
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-patient-religion
Binding: Religion (required)
.... extension:occupation 1..1 DP_CodeableConcept Patient Occupation
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-occupation
Binding: Occupation (required)
.... identifier:All Slices Content/Rules for all slices
..... type 1..1 DP_CodeableConcept Description of identifier
Binding: Patient Identifier Type (required)
.... identifier:iqama C 0..1 Identifier Saudi Resident Id (Iqama)
Constraints: BV-00798
..... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRC
.... identifier:passport C 0..1 Identifier Passport Number
Constraints: BV-00481
..... extension 1..* Extension Extension
..... Slices for extension Content/Rules for all slices
...... extension:country 1..1 DP_CodeableConcept Patient Identifier Country
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-identifier-country
Binding: Iso3166-1-3 (required)
..... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
.... identifier:nationalid C 0..1 Identifier National Identifier
Constraints: BV-00797
..... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NI
.... identifier:visa 0..1 Identifier Visa Number
..... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: VP
....... display 1..1 string Representation defined by the system
Fixed Value: Visitor Permit
.... identifier:medicalrecord 0..1 Identifier Medical Record Number
..... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
... active 1..1 boolean Whether this patient's record is in active use
... name 1..1 DP_HumanName A name associated with the patient
... telecom S 0..1 ContactPoint A contact detail for the individual
... gender 1..1 DP_code male | female | other | unknown
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:ksa-administrative-gender 1..1 DP_CodeableConcept Administrative Gender
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-ksa-administrative-gender
Binding: KSA Administrative Gender (required)
... birthDate 1..1 DP_date The date of birth for the individual
... Slices for deceased[x] S 0..1 boolean, dateTime Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceased[x]:deceasedBoolean S 0..1 boolean Indicates if the individual is deceased or not
.... deceased[x]:deceasedDateTime S 0..1 DP_dateTime Indicates if the individual is deceased or not
... address S 0..1 DP_Address An address for the individual
... maritalStatus 1..1 DP_CodeableConcept Marital (civil) status of a patient
Binding: KSA Marital Status (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.identifier.type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.maritalStatus Base required KSA Marital Status 📦0.4.0 This IG

Constraints

Id Grade Path(s) Description Expression
BV-00339 error Patient Patient active is not using the specified value 'true' active.exists() and active = true
BV-00481 error Patient.identifier:passport Patient's passport issuing country is not provided extension('http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-identifier-country').exists()
BV-00797 error Patient.identifier:nationalid Patient Identifier shall consist of 10 digits starting with 2 when National ID used value.substring(0,1) = '1' and value.length() = 10
BV-00798 error Patient.identifier:iqama Patient Identifier shall consist of 10 digits starting with 2 when Iqama ID used value.substring(0,1) = '2' and value.length() = 10
BV-00848 error Patient Patient Birthdate Shall not be more than currentDate or before 1st Jan 1900 birthDate >= @1900-01-01 and birthDate <= today()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
Constraints: BV-00339, BV-00848
... id Σ 1..1 id Logical id of this artifact
Max Length:64
... meta Σ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* DP_canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... 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
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:patient-religion S 0..1 DP_CodeableConcept Patient Religion
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-patient-religion
Binding: Religion (required)
.... extension:occupation C 1..1 DP_CodeableConcept Patient Occupation
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-occupation
Binding: Occupation (required)
Constraints: DT-01542, IC-01561
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* DP_Identifier_B An identifier for this patient
Slice: Unordered, Closed by value:type
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
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 Σ 1..1 DP_CodeableConcept Description of identifier
Binding: Patient Identifier Type (required)
..... system Σ 1..1 DP_uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
Max Length:50
..... 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:iqama ΣC 0..1 Identifier Saudi Resident Id (Iqama)
Constraints: BV-00798
..... id 0..1 string 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: Patient Identifier Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRC
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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 ΣC 0..1 Identifier Passport Number
Constraints: BV-00481
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:country 1..1 DP_CodeableConcept Patient Identifier Country
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-identifier-country
Binding: Iso3166-1-3 (required)
..... 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: Patient Identifier Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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:nationalid ΣC 0..1 Identifier National Identifier
Constraints: BV-00797
..... id 0..1 string 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: Patient Identifier Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NI
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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:visa Σ 0..1 Identifier Visa Number
..... id 0..1 string 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: Patient Identifier Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: VP
....... display 1..1 string Representation defined by the system
Fixed Value: Visitor Permit
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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:medicalrecord Σ 0..1 Identifier Medical Record Number
..... id 0..1 string 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: Patient Identifier Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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 ?!Σ 1..1 boolean Whether this patient's record is in active use
... name Σ 1..1 DP_HumanName A name associated with the patient
... telecom SΣ 0..1 ContactPoint A contact detail for the individual
... gender Σ 1..1 DP_code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:ksa-administrative-gender 1..1 DP_CodeableConcept Administrative Gender
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-ksa-administrative-gender
Binding: KSA Administrative Gender (required)
.... value 0..1 string Primitive value for code
Max Length:30
... birthDate Σ 1..1 DP_date The date of birth for the individual
... Slices for deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedBoolean ?!SΣ 0..1 boolean Indicates if the individual is deceased or not
.... deceased[x]:deceasedDateTime ?!SΣ 0..1 DP_dateTime Indicates if the individual is deceased or not
... address SΣ 0..1 DP_Address An address for the individual
... maritalStatus 1..1 DP_CodeableConcept Marital (civil) status of a patient
Binding: KSA Marital Status (required)
... 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 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 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: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Patient.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.identifier:iqama.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:iqama.​type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.identifier:passport.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:passport.​type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.identifier:nationalid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:nationalid.​type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.identifier:visa.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:visa.​type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.identifier:medicalrecord.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:medicalrecord.​type Base required Patient Identifier Type 📦0.4.0 This IG
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.maritalStatus Base required KSA Marital Status 📦0.4.0 This IG
Patient.contact.relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
BV-00339 error Patient Patient active is not using the specified value 'true' active.exists() and active = true
BV-00481 error Patient.identifier:passport Patient's passport issuing country is not provided extension('http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-identifier-country').exists()
BV-00797 error Patient.identifier:nationalid Patient Identifier shall consist of 10 digits starting with 2 when National ID used value.substring(0,1) = '1' and value.length() = 10
BV-00798 error Patient.identifier:iqama Patient Identifier shall consist of 10 digits starting with 2 when Iqama ID used value.substring(0,1) = '2' and value.length() = 10
BV-00848 error Patient Patient Birthdate Shall not be more than currentDate or before 1st Jan 1900 birthDate >= @1900-01-01 and birthDate <= today()
DT-01542 error Patient.extension:occupation Invalid data type used for Patient extension occupation. value.exists() implies value is CodeableConcept
IC-01561 error Patient.extension:occupation Patient extension occupation is not following the specified cardinality within the message profile. value.exists() implies value.count() = 1
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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()

 

Other representations of profile: CSV, Excel, Schematron