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

Virtually Healthcare HL7 FHIR 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/Virtually-Healthcare-FHIR-Implementation-Guide/ and changes regularly. See the Directory of published versions

Data Type Profile: UK Professional License

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

NHS Data Dictionary CONSULTANT CODE and GENERAL MEDICAL PRACTITIONER PPD CODE.

General Medical Councial Reference Number

NHS Data Dictionary: GENERAL MEDICAL COUNCIL REFERENCE NUMBER

Format: ^[C]{1}[0-9]{7}$ (CNNNNNNN)

Naming System (HL7 FHIR, v2 and OID): gmc-number

General Dental Council Registration Number

NHS Data Dictionary [GENERAL DENTAL COUNCIL REGISTRATION NUMBER)(https://www.datadictionary.nhs.uk/attributes/general_dental_council_registration_number.html)

Format: ^[C]{1}[D]{1}[0-9]{6}$ (CDNNNNNN)

Nursing and Midwifery Council Code

Format: (NNANNNNA)

General Pharmaceutical Council Code

Format: (NNNNNNN)

Health and Care Professional Council Code

Format: (AANNNNNN)

Code Format Example
GP/medical prescriber (DIN) NNNNNN 954000
Nurse prescriber (NMC) NNANNNNA 71A2998E
Pharmacist prescriber (GPHC) NNNNNNN 2033467
Optometrist prescriber NN-NNNNN 01-09491
Podiatrist prescriber (HCPC) CHNNNNNN CH029821
Physiotherapist prescriber (HCPC) PHNNNNNN PH095159
Radiographer prescriber (HCPC) RANNNNNN RA088262
Dietician prescriber (HCPC) DTNNNNNN DT012345
Paramedic prescriber (HCPC) PANNNNNN PA054321

General Medical Practitioner

NHS Data Dictionary: GENERAL MEDICAL PRACTITIONER PPD CODE. Formerly called GP General National Code

Format: ^[G]{1}[01234589]{1}[0-9]{6}$ (G[1234589]NNNNNN)

Naming System (HL7 FHIR, v2 and OID): gmp-number

Usage:

Formal Views of Profile Content

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

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier Identifier
... type 0..1 CodeableConcept For doctors type.code = MD?
Fixed Value: As shown (License number)
.... coding 1..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: LN
... system 1..1 uri The namespace for the identifier value
Binding: UK Professional License (required)
... value 1..1 string The value that is unique

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Identifier.systemrequiredProfessionalLicense (a valid code from UK Professional License)
https://fhir.virtually.healthcare/ValueSet/ProfessionalLicense
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..* Identifier An identifier intended for computation
... 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 For doctors type.code = MD?
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.


Fixed Value: As shown (License number)
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..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..0 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LN
..... display 0..0 string Representation defined by the system
..... userSelected 0..0 boolean If this coding was chosen directly by the user
.... text 0..0 string Plain text representation of the concept
... system Σ 1..1 uri The namespace for the identifier value
Binding: UK Professional License (required)
Example General: http://www.acme.com/identifiers/patient
... value Σ 1..1 string The value that is unique
Example General: 123456

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typeextensibleFixed Value: LN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Identifier.systemrequiredProfessionalLicense (a valid code from UK Professional License)
https://fhir.virtually.healthcare/ValueSet/ProfessionalLicense
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..* Identifier An identifier intended for computation
... 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 For doctors type.code = MD?
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.


Fixed Value: As shown (License number)
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..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..0 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LN
..... display 0..0 string Representation defined by the system
..... userSelected 0..0 boolean If this coding was chosen directly by the user
.... text 0..0 string Plain text representation of the concept
... system Σ 1..1 uri The namespace for the identifier value
Binding: UK Professional License (required)
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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typeextensibleFixed Value: LN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Identifier.systemrequiredProfessionalLicense (a valid code from UK Professional License)
https://fhir.virtually.healthcare/ValueSet/ProfessionalLicense
from this IG

This structure is derived from Identifier

Summary

Mandatory: 2 elements
Fixed: 1 element

Differential View

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier Identifier
... type 0..1 CodeableConcept For doctors type.code = MD?
Fixed Value: As shown (License number)
.... coding 1..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: LN
... system 1..1 uri The namespace for the identifier value
Binding: UK Professional License (required)
... value 1..1 string The value that is unique

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Identifier.systemrequiredProfessionalLicense (a valid code from UK Professional License)
https://fhir.virtually.healthcare/ValueSet/ProfessionalLicense
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..* Identifier An identifier intended for computation
... 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 For doctors type.code = MD?
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.


Fixed Value: As shown (License number)
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..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..0 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LN
..... display 0..0 string Representation defined by the system
..... userSelected 0..0 boolean If this coding was chosen directly by the user
.... text 0..0 string Plain text representation of the concept
... system Σ 1..1 uri The namespace for the identifier value
Binding: UK Professional License (required)
Example General: http://www.acme.com/identifiers/patient
... value Σ 1..1 string The value that is unique
Example General: 123456

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typeextensibleFixed Value: LN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Identifier.systemrequiredProfessionalLicense (a valid code from UK Professional License)
https://fhir.virtually.healthcare/ValueSet/ProfessionalLicense
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..* Identifier An identifier intended for computation
... 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 For doctors type.code = MD?
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.


Fixed Value: As shown (License number)
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..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..0 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LN
..... display 0..0 string Representation defined by the system
..... userSelected 0..0 boolean If this coding was chosen directly by the user
.... text 0..0 string Plain text representation of the concept
... system Σ 1..1 uri The namespace for the identifier value
Binding: UK Professional License (required)
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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typeextensibleFixed Value: LN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Identifier.systemrequiredProfessionalLicense (a valid code from UK Professional License)
https://fhir.virtually.healthcare/ValueSet/ProfessionalLicense
from this IG

This structure is derived from Identifier

Summary

Mandatory: 2 elements
Fixed: 1 element

 

Other representations of profile: CSV, Excel, Schematron