Virtually Healthcare HL7 FHIR R4 Implementation Guide
0.1.0-current - ci-build United Kingdom flag

Virtually Healthcare HL7 FHIR R4 Implementation Guide, published by Virtually Healthcare. This guide is not an authorized publication; it is the continuous build for version 0.1.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Virtually-Healthcare/HL7-FHIR-Implementation-Guide/ and changes regularly. See the Directory of published versions

Resource Profile: Practitioner

Official URL: https://fhir.virtually.healthcare/StructureDefinition/Practitioner Version: 0.1.0-current
Draft as of 2024-11-24 Computable Name: Practitioner

Extension of UKCore Practitioner and includes elements from IHE Mobile Care Services Discovery (mCSD)

Usage:

Formal Views of Profile Content

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

This structure is derived from UKCorePractitioner

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner UKCorePractitioner
... Slices for extension Content/Rules for all slices
.... role 0..1 (Complex) EMIS Practitioner Role
URL: https://fhir.virtually.healthcare/StructureDefinition/Role
... identifier 1..* Identifier An identifier that applies to this person in this role.
.... type 0..1 CodeableConcept Description of identifier
Binding: Identifier Type (required)
.... system 1..1 uri The namespace for the identifier value
Binding: Practitioner Identifiers (extensible)
.... value 1..1 string The value that is unique

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Practitioner.identifier.typerequiredIdentifierTypeVH
https://fhir.virtually.healthcare/ValueSet/IdentifierTypeVH
from this IG
Practitioner.identifier.systemextensiblePractitionerIdentifiers
https://fhir.virtually.healthcare/ValueSet/PractitionerIdentifiers
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* UKCorePractitioner 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 Content/Rules for all slices
.... role 0..1 (Complex) EMIS Practitioner Role
URL: https://fhir.virtually.healthcare/StructureDefinition/Role
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier SΣ 1..* Identifier An identifier that applies to this person in this role.
.... 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: Identifier Type (required)
.... system Σ 1..1 uri The namespace for the identifier value
Binding: Practitioner Identifiers (extensible)
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
... name SΣ 0..* HumanName The name(s) associated with the practitioner.
... telecom SΣC 0..* ContactPoint A contact detail for the practitioner (that apply to all roles).
cpt-2: A system is required if a value is provided.

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.typerequiredIdentifierTypeVH
https://fhir.virtually.healthcare/ValueSet/IdentifierTypeVH
from this IG
Practitioner.identifier.systemextensiblePractitionerIdentifiers
https://fhir.virtually.healthcare/ValueSet/PractitionerIdentifiers
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* UKCorePractitioner 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... role 0..1 (Complex) EMIS Practitioner Role
URL: https://fhir.virtually.healthcare/StructureDefinition/Role
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier SΣ 1..* Identifier An identifier that applies to this person in this role.
.... 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: Identifier Type (required)
.... system Σ 1..1 uri The namespace for the identifier value
Binding: Practitioner Identifiers (extensible)
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active Σ 0..1 boolean Whether this practitioner's record is in active use
... name SΣ 0..* HumanName The name(s) associated with the practitioner.
... telecom SΣC 0..* ContactPoint A contact detail for the practitioner (that apply to all roles).
cpt-2: A system is required if a value is provided.
... address Σ 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 0..1 date The date on which the practitioner was born
... photo C 0..* Attachment Image of the person
att-1: If the Attachment has data, it SHALL have a contentType
... qualification 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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 C 0..1 Period Period during which the qualification is valid
per-1: If present, start SHALL have a lower value than end
.... issuer C 0..1 Reference(Organization) Organization that regulates and issues the qualification
ref-1: SHALL have a contained resource if a local reference is provided
... communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: AllLanguages (required): A ValueSet that identifies the language used by a person.

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.typerequiredIdentifierTypeVH
https://fhir.virtually.healthcare/ValueSet/IdentifierTypeVH
from this IG
Practitioner.identifier.systemextensiblePractitionerIdentifiers
https://fhir.virtually.healthcare/ValueSet/PractitionerIdentifiers
from this IG
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.communicationrequiredAllLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/all-languages
from the FHIR Standard

This structure is derived from UKCorePractitioner

Summary

Mandatory: 3 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from UKCorePractitioner

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner UKCorePractitioner
... Slices for extension Content/Rules for all slices
.... role 0..1 (Complex) EMIS Practitioner Role
URL: https://fhir.virtually.healthcare/StructureDefinition/Role
... identifier 1..* Identifier An identifier that applies to this person in this role.
.... type 0..1 CodeableConcept Description of identifier
Binding: Identifier Type (required)
.... system 1..1 uri The namespace for the identifier value
Binding: Practitioner Identifiers (extensible)
.... value 1..1 string The value that is unique

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Practitioner.identifier.typerequiredIdentifierTypeVH
https://fhir.virtually.healthcare/ValueSet/IdentifierTypeVH
from this IG
Practitioner.identifier.systemextensiblePractitionerIdentifiers
https://fhir.virtually.healthcare/ValueSet/PractitionerIdentifiers
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* UKCorePractitioner 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 Content/Rules for all slices
.... role 0..1 (Complex) EMIS Practitioner Role
URL: https://fhir.virtually.healthcare/StructureDefinition/Role
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier SΣ 1..* Identifier An identifier that applies to this person in this role.
.... 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: Identifier Type (required)
.... system Σ 1..1 uri The namespace for the identifier value
Binding: Practitioner Identifiers (extensible)
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
... name SΣ 0..* HumanName The name(s) associated with the practitioner.
... telecom SΣC 0..* ContactPoint A contact detail for the practitioner (that apply to all roles).
cpt-2: A system is required if a value is provided.

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.typerequiredIdentifierTypeVH
https://fhir.virtually.healthcare/ValueSet/IdentifierTypeVH
from this IG
Practitioner.identifier.systemextensiblePractitionerIdentifiers
https://fhir.virtually.healthcare/ValueSet/PractitionerIdentifiers
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* UKCorePractitioner 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... role 0..1 (Complex) EMIS Practitioner Role
URL: https://fhir.virtually.healthcare/StructureDefinition/Role
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier SΣ 1..* Identifier An identifier that applies to this person in this role.
.... 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: Identifier Type (required)
.... system Σ 1..1 uri The namespace for the identifier value
Binding: Practitioner Identifiers (extensible)
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active Σ 0..1 boolean Whether this practitioner's record is in active use
... name SΣ 0..* HumanName The name(s) associated with the practitioner.
... telecom SΣC 0..* ContactPoint A contact detail for the practitioner (that apply to all roles).
cpt-2: A system is required if a value is provided.
... address Σ 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 0..1 date The date on which the practitioner was born
... photo C 0..* Attachment Image of the person
att-1: If the Attachment has data, it SHALL have a contentType
... qualification 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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 C 0..1 Period Period during which the qualification is valid
per-1: If present, start SHALL have a lower value than end
.... issuer C 0..1 Reference(Organization) Organization that regulates and issues the qualification
ref-1: SHALL have a contained resource if a local reference is provided
... communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: AllLanguages (required): A ValueSet that identifies the language used by a person.

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.typerequiredIdentifierTypeVH
https://fhir.virtually.healthcare/ValueSet/IdentifierTypeVH
from this IG
Practitioner.identifier.systemextensiblePractitionerIdentifiers
https://fhir.virtually.healthcare/ValueSet/PractitionerIdentifiers
from this IG
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.communicationrequiredAllLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/all-languages
from the FHIR Standard

This structure is derived from UKCorePractitioner

Summary

Mandatory: 3 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron