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 Practitioner

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

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

Nphies Practitioner 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
.. Practitioner C 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: BV-00198, BV-00199
... 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
... identifier SΣ 1..* DP_Identifier_B An identifier for the person as this agent
.... 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: Identifier Type Codes (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
... active Σ 1..1 boolean Whether this practitioner's record is in active use
Required Pattern: true
... name SΣ 0..* DP_HumanName The name(s) associated with the practitioner
... gender SΣ 0..1 DP_code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:ksa-administrative-gender S 0..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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Practitioner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Practitioner.identifier.​type Base required IdentifierType 📦4.0.1 FHIR Std.
Practitioner.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
BV-00198 error Practitioner The practitioner role identifier is not provided. identifier.exists()
BV-00199 error Practitioner The PaymentReconciliation identifier does not exist. identifier.exists() implies identifier.value.exists()
dom-2 error Practitioner If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Practitioner 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 Practitioner 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 Practitioner If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Practitioner 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 Practitioner

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Practitioner C 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: BV-00198, BV-00199
... 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
... identifier S 1..* DP_Identifier_B An identifier for the person as this agent
.... type 1..1 DP_CodeableConcept Description of identifier
Binding: Identifier Type Codes (required)
... name S 0..* DP_HumanName The name(s) associated with the practitioner
... gender S 0..1 DP_code male | female | other | unknown
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:ksa-administrative-gender S 0..1 DP_CodeableConcept Administrative Gender
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-ksa-administrative-gender
Binding: KSA Administrative Gender (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Practitioner.identifier.​type Base required IdentifierType 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
BV-00198 error Practitioner The practitioner role identifier is not provided. identifier.exists()
BV-00199 error Practitioner The PaymentReconciliation identifier does not exist. identifier.exists() implies identifier.value.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Practitioner C 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: BV-00198, BV-00199
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* DP_Identifier_B An identifier for the person as this agent
.... 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: Identifier Type Codes (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)
... active Σ 1..1 boolean Whether this practitioner's record is in active use
Required Pattern: true
... name SΣ 0..* DP_HumanName The name(s) associated with the practitioner
... telecom Σ 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
... address Σ 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
... gender SΣ 0..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 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:ksa-administrative-gender S 0..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 Σ 0..1 date The date on which the practitioner was born
... photo 0..* Attachment Image of the person
... qualification 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
.... 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
.... identifier 0..* Identifier An identifier for this qualification for the practitioner
.... code 1..1 CodeableConcept Coded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.
.... period 0..1 Period Period during which the qualification is valid
.... issuer 0..1 Reference(Organization) Organization that regulates and issues the qualification
... communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding


doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Practitioner.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Practitioner.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Practitioner.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Practitioner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Practitioner.identifier.​type Base required IdentifierType 📦4.0.1 FHIR Std.
Practitioner.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Practitioner.qualification.​code Base example v2 table 0360, Version 2.7 📦0360 FHIR Std.
Practitioner.communication Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
BV-00198 error Practitioner The practitioner role identifier is not provided. identifier.exists()
BV-00199 error Practitioner The PaymentReconciliation identifier does not exist. identifier.exists() implies identifier.value.exists()
dom-2 error Practitioner If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Practitioner 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 Practitioner 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 Practitioner If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Practitioner 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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Practitioner C 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: BV-00198, BV-00199
... 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
... identifier SΣ 1..* DP_Identifier_B An identifier for the person as this agent
.... 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: Identifier Type Codes (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
... active Σ 1..1 boolean Whether this practitioner's record is in active use
Required Pattern: true
... name SΣ 0..* DP_HumanName The name(s) associated with the practitioner
... gender SΣ 0..1 DP_code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:ksa-administrative-gender S 0..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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Practitioner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Practitioner.identifier.​type Base required IdentifierType 📦4.0.1 FHIR Std.
Practitioner.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
BV-00198 error Practitioner The practitioner role identifier is not provided. identifier.exists()
BV-00199 error Practitioner The PaymentReconciliation identifier does not exist. identifier.exists() implies identifier.value.exists()
dom-2 error Practitioner If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Practitioner 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 Practitioner 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 Practitioner If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Practitioner 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 Practitioner

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Practitioner C 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: BV-00198, BV-00199
... 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
... identifier S 1..* DP_Identifier_B An identifier for the person as this agent
.... type 1..1 DP_CodeableConcept Description of identifier
Binding: Identifier Type Codes (required)
... name S 0..* DP_HumanName The name(s) associated with the practitioner
... gender S 0..1 DP_code male | female | other | unknown
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:ksa-administrative-gender S 0..1 DP_CodeableConcept Administrative Gender
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-ksa-administrative-gender
Binding: KSA Administrative Gender (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Practitioner.identifier.​type Base required IdentifierType 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
BV-00198 error Practitioner The practitioner role identifier is not provided. identifier.exists()
BV-00199 error Practitioner The PaymentReconciliation identifier does not exist. identifier.exists() implies identifier.value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Practitioner C 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: BV-00198, BV-00199
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* DP_Identifier_B An identifier for the person as this agent
.... 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: Identifier Type Codes (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)
... active Σ 1..1 boolean Whether this practitioner's record is in active use
Required Pattern: true
... name SΣ 0..* DP_HumanName The name(s) associated with the practitioner
... telecom Σ 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
... address Σ 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
... gender SΣ 0..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 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:ksa-administrative-gender S 0..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 Σ 0..1 date The date on which the practitioner was born
... photo 0..* Attachment Image of the person
... qualification 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
.... 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
.... identifier 0..* Identifier An identifier for this qualification for the practitioner
.... code 1..1 CodeableConcept Coded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.
.... period 0..1 Period Period during which the qualification is valid
.... issuer 0..1 Reference(Organization) Organization that regulates and issues the qualification
... communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding


doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Practitioner.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Practitioner.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Practitioner.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Practitioner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Practitioner.identifier.​type Base required IdentifierType 📦4.0.1 FHIR Std.
Practitioner.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Practitioner.qualification.​code Base example v2 table 0360, Version 2.7 📦0360 FHIR Std.
Practitioner.communication Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
BV-00198 error Practitioner The practitioner role identifier is not provided. identifier.exists()
BV-00199 error Practitioner The PaymentReconciliation identifier does not exist. identifier.exists() implies identifier.value.exists()
dom-2 error Practitioner If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Practitioner 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 Practitioner 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 Practitioner If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Practitioner 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()

 

Other representations of profile: CSV, Excel, Schematron