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: Staff Enterprise Number

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

UK Professional Licence should take precedence over staff numbers (i.e. SDS User Id) in HL7 FHIR Reference and other interoperability standards.

E.g. SDS User ID and Ministry of Defence Doctor.

SDS User Id

In NHS Englands Spine Directory Service this is the uid in the nhsPerson object.

This is also SmartCard UUID

Ministry of Defence Doctor

From https://www.datadictionary.nhs.uk/data_elements/referrer_code.html, this may need to be reviewed.

Format: ^[A]{1}[0-9]{7}$ (ANNNNNNN)

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 Description of identifier
Fixed Value: As shown (Staff Enterprise 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: ESN
... system 1..1 uri The namespace for the identifier value
Binding: UK StaffNumber (required)
... value 1..1 string The value that is unique
... assigner 0..1 Reference(Organization) Assigning organisation, populate if known (i.e. X24/X26 for NHS England)
.... identifier 0..1 OrganisationCode An identifier intended for computation

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Identifier.systemrequiredStaffNumber (a valid code from Staff Number)
https://fhir.virtually.healthcare/ValueSet/StaffNumber
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 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.


Fixed Value: As shown (Staff Enterprise 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: ESN
..... 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 StaffNumber (required)
Example General: http://www.acme.com/identifiers/patient
... value Σ 1..1 string The value that is unique
Example General: 123456
... assigner Σ 0..1 Reference(Organization) Assigning organisation, populate if known (i.e. X24/X26 for NHS England)
.... identifier 0..1 OrganisationCode An identifier intended for computation

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: ESN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Identifier.systemrequiredStaffNumber (a valid code from Staff Number)
https://fhir.virtually.healthcare/ValueSet/StaffNumber
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 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.


Fixed Value: As shown (Staff Enterprise 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: ESN
..... 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 StaffNumber (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) Assigning organisation, populate if known (i.e. X24/X26 for NHS England)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier 0..1 OrganisationCode An identifier intended for computation
.... display Σ 0..1 string Text alternative for the resource

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: ESN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Identifier.systemrequiredStaffNumber (a valid code from Staff Number)
https://fhir.virtually.healthcare/ValueSet/StaffNumber
from this IG
Identifier.assigner.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

This structure is derived from Identifier

Summary

Mandatory: 2 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier Identifier
... type 0..1 CodeableConcept Description of identifier
Fixed Value: As shown (Staff Enterprise 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: ESN
... system 1..1 uri The namespace for the identifier value
Binding: UK StaffNumber (required)
... value 1..1 string The value that is unique
... assigner 0..1 Reference(Organization) Assigning organisation, populate if known (i.e. X24/X26 for NHS England)
.... identifier 0..1 OrganisationCode An identifier intended for computation

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Identifier.systemrequiredStaffNumber (a valid code from Staff Number)
https://fhir.virtually.healthcare/ValueSet/StaffNumber
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 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.


Fixed Value: As shown (Staff Enterprise 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: ESN
..... 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 StaffNumber (required)
Example General: http://www.acme.com/identifiers/patient
... value Σ 1..1 string The value that is unique
Example General: 123456
... assigner Σ 0..1 Reference(Organization) Assigning organisation, populate if known (i.e. X24/X26 for NHS England)
.... identifier 0..1 OrganisationCode An identifier intended for computation

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: ESN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Identifier.systemrequiredStaffNumber (a valid code from Staff Number)
https://fhir.virtually.healthcare/ValueSet/StaffNumber
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 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.


Fixed Value: As shown (Staff Enterprise 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: ESN
..... 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 StaffNumber (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) Assigning organisation, populate if known (i.e. X24/X26 for NHS England)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier 0..1 OrganisationCode An identifier intended for computation
.... display Σ 0..1 string Text alternative for the resource

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: ESN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Identifier.systemrequiredStaffNumber (a valid code from Staff Number)
https://fhir.virtually.healthcare/ValueSet/StaffNumber
from this IG
Identifier.assigner.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

This structure is derived from Identifier

Summary

Mandatory: 2 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron