0.1.0 - ci-build

kenyaClaimsIG - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: SHAPractitioner

Official URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/SHAPractitioner Version: 0.1.0
Draft as of 2024-09-06 Computable Name: SHAPractitioner

Profile for practitioner resource.

Usage:

Formal Views of Profile Content

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

This structure is derived from Practitioner

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner Practitioner
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... professionalCadre S 0..1 CodeableConcept Professional Cadre
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/professional-cadre
.... specialty S 0..1 CodeableConcept Practitioner Specialty
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/specialty
... identifier S 1..1 Identifier An identifier for the person as this agent
.... use S 1..1 code usual | official | temp | secondary | old (If known)
.... type
..... coding
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 1..1 string Representation defined by the system
..... text S 1..1 string Plain text representation of the concept
.... value S 1..1 string The value that is unique
... active S 1..1 boolean Whether this practitioner's record is in active use
.... family S 1..1 string Family name (often called 'Surname')
.... given S 1..1 string Given names (not always 'first'). Includes middle names
.... prefix 0..1 string Practitioner Salutation
Binding: Salutation (required)
... telecom S 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
.... system S 1..1 code phone | fax | email | pager | url | sms | other
.... value S 1..1 string The actual contact point details
.... use S 1..1 code home | work | temp | old | mobile - purpose of this contact point
... address
.... use S 0..1 code home | work | temp | old | billing - purpose of this address
.... text S 0..1 string Text representation of the address
.... city S 0..1 string Town
.... district S 0..1 string Sub County
.... state S 0..1 string County
.... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... gender S 1..1 code male | female | other | unknown
... birthDate S 1..1 date The date on which the practitioner was born
... qualification S 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... qualificationType S 0..1 code Qualification type
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/qualification-type
Binding: Practitioner's Qualifification Type (required)
..... qualificationInstitution S 0..1 code Qulaification Institution
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/qualification-institution
..... currentLicenseNumber S 0..1 string Current License Number
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/practitioner-license-number
..... licenseOperationalStatus S 0..1 code Operational Status
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/operational-status
Binding: Practitioner's Operational Status (required)
..... boardRegistrationNumber S 0..1 string Board Registration Number
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/board-registration-number
..... LicenseRenewalDuration S 0..1 code License Renewal Duration
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/license-renewal-duration
Binding: Practitioner's License Current Renewal Duration (required)
.... code S 1..1 CodeableConcept Qualification/Licence
.... period
..... start S 1..1 dateTime Starting time with inclusive boundary
..... end S 0..1 dateTime End time with inclusive boundary, if not ongoing

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Practitioner.name.prefixrequiredPT_TITLE
https://shr.tiberbuapps.com/fhir/ValueSet/SalutationVS
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... professionalCadre S 0..1 CodeableConcept Professional Cadre
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/professional-cadre
.... specialty S 0..1 CodeableConcept Practitioner Specialty
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/specialty
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!SΣ 1..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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... coding Σ 0..* Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 1..1 string Representation defined by the system
..... text SΣ 1..1 string Plain text representation of the concept
.... value SΣ 1..1 string The value that is unique
Example General: 123456
... active SΣ 1..1 boolean Whether this practitioner's record is in active use
... name SΣ 1..1 HumanName The name(s) associated with the practitioner
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family SΣ 1..1 string Family name (often called 'Surname')
.... given SΣ 1..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..1 string Practitioner Salutation
Binding: Salutation (required)
This repeating element order: Prefixes appear in the correct order for presenting the name
... telecom SΣ 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... address Σ 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
.... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... text SΣ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... city SΣ 0..1 string Town
Example General: Erewhon
.... district SΣ 0..1 string Sub County
Example General: Madison
.... state SΣ 0..1 string County
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... gender SΣ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ 1..1 date The date on which the practitioner was born
... qualification S 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... qualificationType S 0..1 code Qualification type
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/qualification-type
Binding: Practitioner's Qualifification Type (required)
..... qualificationInstitution S 0..1 code Qulaification Institution
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/qualification-institution
..... currentLicenseNumber S 0..1 string Current License Number
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/practitioner-license-number
..... licenseOperationalStatus S 0..1 code Operational Status
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/operational-status
Binding: Practitioner's Operational Status (required)
..... boardRegistrationNumber S 0..1 string Board Registration Number
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/board-registration-number
..... LicenseRenewalDuration S 0..1 code License Renewal Duration
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/license-renewal-duration
Binding: Practitioner's License Current Renewal Duration (required)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code S 1..1 CodeableConcept Qualification/Licence
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
..... start SΣC 1..1 dateTime Starting time with inclusive boundary
..... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Practitioner.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Practitioner.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Practitioner.name.prefixrequiredPT_TITLE
https://shr.tiberbuapps.com/fhir/ValueSet/SalutationVS
from this IG
Practitioner.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Practitioner.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Practitioner.qualification.codeexamplev2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerIf 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-4errorPractitionerIf 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-5errorPractitionerIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... professionalCadre S 0..1 CodeableConcept Professional Cadre
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/professional-cadre
.... specialty S 0..1 CodeableConcept Practitioner Specialty
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/specialty
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..1 Identifier 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 ?!SΣ 1..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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 1..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text SΣ 1..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 SΣ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active SΣ 1..1 boolean Whether this practitioner's record is in active use
... name SΣ 1..1 HumanName The name(s) associated with the practitioner
.... 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 | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ 0..1 string Text representation of the full name
.... family SΣ 1..1 string Family name (often called 'Surname')
.... given SΣ 1..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..1 string Practitioner Salutation
Binding: Salutation (required)
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... telecom SΣ 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... address Σ 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
.... 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 ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text SΣ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string Town
Example General: Erewhon
.... district SΣ 0..1 string Sub County
Example General: Madison
.... state SΣ 0..1 string County
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... gender SΣ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ 1..1 date The date on which the practitioner was born
... photo 0..* Attachment Image of the person
... qualification S 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... qualificationType S 0..1 code Qualification type
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/qualification-type
Binding: Practitioner's Qualifification Type (required)
..... qualificationInstitution S 0..1 code Qulaification Institution
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/qualification-institution
..... currentLicenseNumber S 0..1 string Current License Number
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/practitioner-license-number
..... licenseOperationalStatus S 0..1 code Operational Status
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/operational-status
Binding: Practitioner's Operational Status (required)
..... boardRegistrationNumber S 0..1 string Board Registration Number
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/board-registration-number
..... LicenseRenewalDuration S 0..1 code License Renewal Duration
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/license-renewal-duration
Binding: Practitioner's License Current Renewal Duration (required)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..* Identifier An identifier for this qualification for the practitioner
.... code S 1..1 CodeableConcept Qualification/Licence
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
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start SΣC 1..1 dateTime Starting time with inclusive boundary
..... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... 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

PathConformanceValueSetURI
Practitioner.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Practitioner.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Practitioner.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Practitioner.name.prefixrequiredPT_TITLE
https://shr.tiberbuapps.com/fhir/ValueSet/SalutationVS
from this IG
Practitioner.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Practitioner.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Practitioner.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Practitioner.qualification.codeexamplev2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
from the FHIR Standard
Practitioner.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

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

Differential View

This structure is derived from Practitioner

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner Practitioner
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... professionalCadre S 0..1 CodeableConcept Professional Cadre
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/professional-cadre
.... specialty S 0..1 CodeableConcept Practitioner Specialty
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/specialty
... identifier S 1..1 Identifier An identifier for the person as this agent
.... use S 1..1 code usual | official | temp | secondary | old (If known)
.... type
..... coding
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 1..1 string Representation defined by the system
..... text S 1..1 string Plain text representation of the concept
.... value S 1..1 string The value that is unique
... active S 1..1 boolean Whether this practitioner's record is in active use
.... family S 1..1 string Family name (often called 'Surname')
.... given S 1..1 string Given names (not always 'first'). Includes middle names
.... prefix 0..1 string Practitioner Salutation
Binding: Salutation (required)
... telecom S 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
.... system S 1..1 code phone | fax | email | pager | url | sms | other
.... value S 1..1 string The actual contact point details
.... use S 1..1 code home | work | temp | old | mobile - purpose of this contact point
... address
.... use S 0..1 code home | work | temp | old | billing - purpose of this address
.... text S 0..1 string Text representation of the address
.... city S 0..1 string Town
.... district S 0..1 string Sub County
.... state S 0..1 string County
.... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... gender S 1..1 code male | female | other | unknown
... birthDate S 1..1 date The date on which the practitioner was born
... qualification S 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... qualificationType S 0..1 code Qualification type
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/qualification-type
Binding: Practitioner's Qualifification Type (required)
..... qualificationInstitution S 0..1 code Qulaification Institution
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/qualification-institution
..... currentLicenseNumber S 0..1 string Current License Number
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/practitioner-license-number
..... licenseOperationalStatus S 0..1 code Operational Status
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/operational-status
Binding: Practitioner's Operational Status (required)
..... boardRegistrationNumber S 0..1 string Board Registration Number
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/board-registration-number
..... LicenseRenewalDuration S 0..1 code License Renewal Duration
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/license-renewal-duration
Binding: Practitioner's License Current Renewal Duration (required)
.... code S 1..1 CodeableConcept Qualification/Licence
.... period
..... start S 1..1 dateTime Starting time with inclusive boundary
..... end S 0..1 dateTime End time with inclusive boundary, if not ongoing

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Practitioner.name.prefixrequiredPT_TITLE
https://shr.tiberbuapps.com/fhir/ValueSet/SalutationVS
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... professionalCadre S 0..1 CodeableConcept Professional Cadre
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/professional-cadre
.... specialty S 0..1 CodeableConcept Practitioner Specialty
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/specialty
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!SΣ 1..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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... coding Σ 0..* Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 1..1 string Representation defined by the system
..... text SΣ 1..1 string Plain text representation of the concept
.... value SΣ 1..1 string The value that is unique
Example General: 123456
... active SΣ 1..1 boolean Whether this practitioner's record is in active use
... name SΣ 1..1 HumanName The name(s) associated with the practitioner
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family SΣ 1..1 string Family name (often called 'Surname')
.... given SΣ 1..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..1 string Practitioner Salutation
Binding: Salutation (required)
This repeating element order: Prefixes appear in the correct order for presenting the name
... telecom SΣ 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... address Σ 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
.... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... text SΣ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... city SΣ 0..1 string Town
Example General: Erewhon
.... district SΣ 0..1 string Sub County
Example General: Madison
.... state SΣ 0..1 string County
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... gender SΣ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ 1..1 date The date on which the practitioner was born
... qualification S 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... qualificationType S 0..1 code Qualification type
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/qualification-type
Binding: Practitioner's Qualifification Type (required)
..... qualificationInstitution S 0..1 code Qulaification Institution
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/qualification-institution
..... currentLicenseNumber S 0..1 string Current License Number
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/practitioner-license-number
..... licenseOperationalStatus S 0..1 code Operational Status
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/operational-status
Binding: Practitioner's Operational Status (required)
..... boardRegistrationNumber S 0..1 string Board Registration Number
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/board-registration-number
..... LicenseRenewalDuration S 0..1 code License Renewal Duration
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/license-renewal-duration
Binding: Practitioner's License Current Renewal Duration (required)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code S 1..1 CodeableConcept Qualification/Licence
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
..... start SΣC 1..1 dateTime Starting time with inclusive boundary
..... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Practitioner.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Practitioner.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Practitioner.name.prefixrequiredPT_TITLE
https://shr.tiberbuapps.com/fhir/ValueSet/SalutationVS
from this IG
Practitioner.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Practitioner.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Practitioner.qualification.codeexamplev2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
from the FHIR Standard

Constraints

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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... professionalCadre S 0..1 CodeableConcept Professional Cadre
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/professional-cadre
.... specialty S 0..1 CodeableConcept Practitioner Specialty
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/specialty
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..1 Identifier 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 ?!SΣ 1..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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 1..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text SΣ 1..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 SΣ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active SΣ 1..1 boolean Whether this practitioner's record is in active use
... name SΣ 1..1 HumanName The name(s) associated with the practitioner
.... 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 | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ 0..1 string Text representation of the full name
.... family SΣ 1..1 string Family name (often called 'Surname')
.... given SΣ 1..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..1 string Practitioner Salutation
Binding: Salutation (required)
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... telecom SΣ 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... address Σ 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
.... 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 ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text SΣ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string Town
Example General: Erewhon
.... district SΣ 0..1 string Sub County
Example General: Madison
.... state SΣ 0..1 string County
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... gender SΣ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ 1..1 date The date on which the practitioner was born
... photo 0..* Attachment Image of the person
... qualification S 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... qualificationType S 0..1 code Qualification type
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/qualification-type
Binding: Practitioner's Qualifification Type (required)
..... qualificationInstitution S 0..1 code Qulaification Institution
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/qualification-institution
..... currentLicenseNumber S 0..1 string Current License Number
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/practitioner-license-number
..... licenseOperationalStatus S 0..1 code Operational Status
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/operational-status
Binding: Practitioner's Operational Status (required)
..... boardRegistrationNumber S 0..1 string Board Registration Number
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/board-registration-number
..... LicenseRenewalDuration S 0..1 code License Renewal Duration
URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/license-renewal-duration
Binding: Practitioner's License Current Renewal Duration (required)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..* Identifier An identifier for this qualification for the practitioner
.... code S 1..1 CodeableConcept Qualification/Licence
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
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start SΣC 1..1 dateTime Starting time with inclusive boundary
..... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... 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

PathConformanceValueSetURI
Practitioner.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Practitioner.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Practitioner.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Practitioner.name.prefixrequiredPT_TITLE
https://shr.tiberbuapps.com/fhir/ValueSet/SalutationVS
from this IG
Practitioner.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Practitioner.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Practitioner.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Practitioner.qualification.codeexamplev2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
from the FHIR Standard
Practitioner.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

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

 

Other representations of profile: CSV, Excel, Schematron