Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the STU3 profiles here.
Official URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Interweave-Practitioner | Version: 0.0.1 | |||
Draft as of 2024-07-15 | Computable Name: InterweavePractitioner |
Interweave Practitioner resource profile - DRAFT.
Status: DRAFT: For Review
This profile sets minimum expectations for the Practitioner resource. We use the practitioner structure definition as a base to this profile.
This Resource will give the consumer the ability to see information on the person who is directly or indirectly involved in the provisioning of healthcare / social support.
The Practitioner Resource provides information about a person formally involved in the care of a patient on behalf of a healthcare facility. Practitioners include but are not limited to physicians, nurses, pharmacists, therapists, technologists, and social workers.
Please note, this resource could be classed as reference resource and is referenced within multiple other resources as a linked resoure, as such there would not be a specific panel for this resource within the UI.
Name - This is essential to indicate who the practitioner is. Only a single name is supported by Care Connect, and for this profile then at a minimum the Family Name is mandatory. (Note that in addition, Given Name, Prefix, and Suffix are considered "Must Support")
Identifier: Must be populated to formally identify the practitioner. UKCore does not have any specific Guidance on range of possible identifiers, as part of Interweave guidance we have added slices for some of the known identifiers, these include:
Or as a last resort if no other professional identifier:
In addition the following fields are "Must Support" - ie they must be populated if relevant and known:
Other fields are optional and may be populated if known - on the understanding that not all data consumers will necessarily make use of them. Points of note include:
Local Id - In some cases there may be a local business identifier. Optional, to include if relevant.
Telecom - It is very useful to provide a contact phone number and/or email if at all possible – to enable further enquiries about any information seen. However caution is needed, as these contact details may be widely seen throughout the region. Only work details suitable for receiving external enquires should be included. Specifically home phone numbers should not be shared.
Gender - May be provided if known, but is not essential.
Communication - Knowing which language(s) a practitioner speaks can help in facilitating communication with patients. Optional, as in general it is assumed that the employing organisation will make any necessary provisions and so largely not relevant for regional sharing.
Address - Discouraged. Addresses should be provided instead on the relevant organisation / location records. For the purposes of regional sharing then practitioner home addresses must NOT be shared.
Birth Date - Removed. For the purposes of regional sharing then the birth date could be considered as unnecessary personal information and is not required.
Photo - Removed. At the present time then photos are not required. Excluded to avoid any complexities with sharing large image files.
Qualifications - Removed. Not releavant to shared care record.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from UKCorePractitioner
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Practitioner | UKCorePractitioner | |||
id | S | 0..1 | id | Logical id of this artifact |
meta | ||||
id | 0..0 | |||
versionId | S | 0..1 | id | Version specific identifier |
lastUpdated | S | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. |
profile | S | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource. |
security | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers | |
Slices for tag | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system | |
tag:Source | S | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data |
id | 0..0 | |||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source | |
version | 0..0 | |||
code | S | 1..1 | code | The Data Provider Id of the system supplying the data |
display | S | 1..1 | string | Name of the system supplying the data |
tag:Provenance | S | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data |
id | 0..0 | |||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance | |
version | 0..0 | |||
code | S | 1..1 | code | The ODS Code of the organisation responsible for the data |
display | S | 1..1 | string | Name of the organisation supplying the data |
implicitRules | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | |
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) | |
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |
Slices for identifier | 1..* | Identifier | An identifier that applies to this person in this role. Slice: Unordered, Open by value:system | |
identifier:All Slices | Content/Rules for all slices | |||
id | 0..0 | |||
identifier:sdsUserID | 0..1 | Identifier | An identifier (sdsUserId) that applies to this person in this role. | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/sds-user-id | |
value | 1..1 | string | The value that is unique | |
assigner | 0..1 | Reference(InterweaveOrganization) | Organization that issued id (may be just text) | |
identifier:sdsRoleProfileID | 0..* | Identifier | An identifier (sdsRoleProfileID) that applies to this person in this role. | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/sds-role-profile-id | |
value | 1..1 | string | The value that is unique | |
assigner | 0..1 | Reference(InterweaveOrganization) | Organization that issued id (may be just text) | |
identifier:gmpNumber | 0..1 | Identifier | An identifier (gmpNumber - General Medical Practitioner) that applies to this person in this role. | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/gmp-number | |
value | 1..1 | string | The value that is unique | |
identifier:gmcNumber | 0..1 | Identifier | An identifier (gmcNumber - General Medical Council / Consultant Code) that applies to this person in this role. | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/gmc-number | |
value | 1..1 | string | The value that is unique | |
identifier:nmcNumber | 0..1 | Identifier | An identifier (nmcNumber - Nursing and Midwifery Council) that applies to this person in this role. | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/nmc-number | |
value | 1..1 | string | The value that is unique | |
identifier:gphcNumber | 0..1 | Identifier | An identifier (gphcNumber - General Pharmaceautical Council Code) that applies to this person in this role. | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/gphc-number | |
value | 1..1 | string | The value that is unique | |
identifier:hcpcNumber | 0..1 | Identifier | An identifier (hcpcNumber - Health and Care Professional Council Code) that applies to this person in this role. | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/hcpc-number | |
value | 1..1 | string | The value that is unique | |
identifier:localIdentifier | 0..1 | Identifier | A local identifier that applies to this person in this role. Please use local identifier at the last resort if none of the other identifiers are not available or as an additional identidier along with others. | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-practitioner-identifier | |
value | 1..1 | string | The value that is unique | |
assigner | 0..1 | Reference(InterweaveOrganization) | Organization that issued id (may be just text) | |
active | S | 0..1 | boolean | Whether this organization is still active - must be both populated and understood if 'false' |
name | 1..1 | HumanName | The name(s) associated with the practitioner. | |
id | 0..0 | |||
extension | 0..0 | |||
text | 0..1 | string | DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements. | |
family | S | 1..1 | string | Family name (often called 'Surname') |
given | S | 0..* | string | Given names (not always 'first'). Includes middle names |
prefix | S | 0..* | string | Parts that come before the name |
suffix | S | 0..* | string | Parts that come after the name |
period | 0..1 | Period | DISCOURAGED: Not relevant as only a single name is permitted | |
telecom | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles). NB these contact details may be widely seen throughout the region. Only work details suitable for receiving external enquires should be included | |
address | 0..* | Address | DISCOURAGED: Addresses should be provided instead on the relevant organisation / location records. For the purposes of regional sharing then practitioner home addresses should NOT be shared. | |
birthDate | 0..0 | |||
photo | 0..0 | |||
qualification | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Practitioner | 0..* | UKCorePractitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |||||
id | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. | ||||
profile | SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource. | ||||
security | Σ | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
Slices for tag | Σ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
tag:Source | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source | ||||
code | SΣ | 1..1 | code | The Data Provider Id of the system supplying the data | ||||
display | SΣ | 1..1 | string | Name of the system supplying the data | ||||
tag:Provenance | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance | ||||
code | SΣ | 1..1 | code | The ODS Code of the organisation responsible for the data | ||||
display | SΣ | 1..1 | string | Name of the organisation supplying the data | ||||
implicitRules | ?!Σ | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | ||||
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣ | 1..* | Identifier | An identifier that applies to this person in this role. Slice: Unordered, Open by value:system | ||||
identifier:All Slices | Content/Rules for all slices | |||||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
identifier:sdsUserID | SΣ | 0..1 | Identifier | An identifier (sdsUserId) 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 . | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/sds-user-id | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
assigner | Σ | 0..1 | Reference(InterweaveOrganization) | Organization that issued id (may be just text) | ||||
identifier:sdsRoleProfileID | SΣ | 0..* | Identifier | An identifier (sdsRoleProfileID) 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 . | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/sds-role-profile-id | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
assigner | Σ | 0..1 | Reference(InterweaveOrganization) | Organization that issued id (may be just text) | ||||
identifier:gmpNumber | SΣ | 0..1 | Identifier | An identifier (gmpNumber - General Medical Practitioner) 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 . | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/gmp-number | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
identifier:gmcNumber | SΣ | 0..1 | Identifier | An identifier (gmcNumber - General Medical Council / Consultant Code) 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 . | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/gmc-number | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
identifier:nmcNumber | SΣ | 0..1 | Identifier | An identifier (nmcNumber - Nursing and Midwifery Council) 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 . | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/nmc-number | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
identifier:gphcNumber | SΣ | 0..1 | Identifier | An identifier (gphcNumber - General Pharmaceautical Council Code) 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 . | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/gphc-number | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
identifier:hcpcNumber | SΣ | 0..1 | Identifier | An identifier (hcpcNumber - Health and Care Professional Council Code) 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 . | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/hcpc-number | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
identifier:localIdentifier | SΣ | 0..1 | Identifier | A local identifier that applies to this person in this role. Please use local identifier at the last resort if none of the other identifiers are not available or as an additional identidier along with others. | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-practitioner-identifier | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
assigner | Σ | 0..1 | Reference(InterweaveOrganization) | Organization that issued id (may be just text) | ||||
active | SΣ | 0..1 | boolean | Whether this organization is still active - must be both populated and understood if 'false' | ||||
name | SΣ | 1..1 | HumanName | The name(s) associated with the practitioner. | ||||
extension | 0..0 | |||||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
text | Σ | 0..1 | string | DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements. | ||||
family | SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
given | SΣ | 0..* | 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 | SΣ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | SΣ | 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 | DISCOURAGED: Not relevant as only a single name is permitted | ||||
telecom | SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles). NB these contact details may be widely seen throughout the region. Only work details suitable for receiving external enquires should be included | ||||
address | Σ | 0..* | Address | DISCOURAGED: Addresses should be provided instead on the relevant organisation / location records. For the purposes of regional sharing then practitioner home addresses should NOT be shared. | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Practitioner.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Practitioner.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Practitioner.meta.tag:Source | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Practitioner.meta.tag:Provenance | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Practitioner.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Practitioner.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:sdsUserID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:sdsRoleProfileID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:gmpNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:gmcNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:nmcNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:gphcNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:hcpcNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:localIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Practitioner.qualification.code | example | v2.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 |
Id | Grade | Path(s) | Details | Requirements |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Practitioner | 0..* | UKCorePractitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |||||
id | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource. | ||||
security | Σ | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
Slices for tag | Σ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
tag:Source | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source | ||||
code | SΣ | 1..1 | code | The Data Provider Id of the system supplying the data | ||||
display | SΣ | 1..1 | string | Name of the system supplying the data | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
tag:Provenance | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance | ||||
code | SΣ | 1..1 | code | The ODS Code of the organisation responsible for the data | ||||
display | SΣ | 1..1 | string | Name of the organisation supplying the data | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
implicitRules | ?!Σ | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | ||||
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣ | 1..* | Identifier | An identifier that applies to this person in this role. Slice: Unordered, Open by value:system | ||||
identifier:All Slices | Content/Rules for all slices | |||||||
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. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..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) | ||||
identifier:sdsUserID | SΣ | 0..1 | Identifier | An identifier (sdsUserId) 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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/sds-user-id | ||||
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(InterweaveOrganization) | Organization that issued id (may be just text) | ||||
identifier:sdsRoleProfileID | SΣ | 0..* | Identifier | An identifier (sdsRoleProfileID) 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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/sds-role-profile-id | ||||
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(InterweaveOrganization) | Organization that issued id (may be just text) | ||||
identifier:gmpNumber | SΣ | 0..1 | Identifier | An identifier (gmpNumber - General Medical Practitioner) 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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/gmp-number | ||||
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) | ||||
identifier:gmcNumber | SΣ | 0..1 | Identifier | An identifier (gmcNumber - General Medical Council / Consultant Code) 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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/gmc-number | ||||
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) | ||||
identifier:nmcNumber | SΣ | 0..1 | Identifier | An identifier (nmcNumber - Nursing and Midwifery Council) 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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/nmc-number | ||||
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) | ||||
identifier:gphcNumber | SΣ | 0..1 | Identifier | An identifier (gphcNumber - General Pharmaceautical Council Code) 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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/gphc-number | ||||
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) | ||||
identifier:hcpcNumber | SΣ | 0..1 | Identifier | An identifier (hcpcNumber - Health and Care Professional Council Code) 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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/hcpc-number | ||||
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) | ||||
identifier:localIdentifier | SΣ | 0..1 | Identifier | A local identifier that applies to this person in this role. Please use local identifier at the last resort if none of the other identifiers are not available or as an additional identidier along with others. | ||||
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. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-practitioner-identifier | ||||
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(InterweaveOrganization) | Organization that issued id (may be just text) | ||||
active | SΣ | 0..1 | boolean | Whether this organization is still active - must be both populated and understood if 'false' | ||||
name | SΣ | 1..1 | HumanName | The name(s) associated with the practitioner. | ||||
extension | 0..0 | |||||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
text | Σ | 0..1 | string | DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements. | ||||
family | SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
given | SΣ | 0..* | 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 | SΣ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | SΣ | 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 | DISCOURAGED: Not relevant as only a single name is permitted | ||||
telecom | SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles). NB these contact details may be widely seen throughout the region. Only work details suitable for receiving external enquires should be included | ||||
address | Σ | 0..* | Address | DISCOURAGED: Addresses should be provided instead on the relevant organisation / location records. For the purposes of regional sharing then practitioner home addresses should NOT be shared. | ||||
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
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. | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Practitioner.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Practitioner.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Practitioner.meta.tag:Source | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Practitioner.meta.tag:Provenance | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Practitioner.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Practitioner.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Practitioner.identifier:sdsUserID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:sdsUserID.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Practitioner.identifier:sdsRoleProfileID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:sdsRoleProfileID.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Practitioner.identifier:gmpNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:gmpNumber.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Practitioner.identifier:gmcNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:gmcNumber.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Practitioner.identifier:nmcNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:nmcNumber.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Practitioner.identifier:gphcNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:gphcNumber.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Practitioner.identifier:hcpcNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:hcpcNumber.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Practitioner.identifier:localIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:localIdentifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Practitioner.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Practitioner.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Practitioner.qualification.code | example | v2.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.communication | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages |
Id | Grade | Path(s) | Details | Requirements |
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 UKCorePractitioner
Summary
Mandatory: 3 elements(22 nested mandatory elements)
Must-Support: 15 elements
Fixed: 10 elements
Prohibited: 11 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from UKCorePractitioner
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Practitioner | UKCorePractitioner | |||
id | S | 0..1 | id | Logical id of this artifact |
meta | ||||
id | 0..0 | |||
versionId | S | 0..1 | id | Version specific identifier |
lastUpdated | S | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. |
profile | S | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource. |
security | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers | |
Slices for tag | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system | |
tag:Source | S | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data |
id | 0..0 | |||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source | |
version | 0..0 | |||
code | S | 1..1 | code | The Data Provider Id of the system supplying the data |
display | S | 1..1 | string | Name of the system supplying the data |
tag:Provenance | S | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data |
id | 0..0 | |||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance | |
version | 0..0 | |||
code | S | 1..1 | code | The ODS Code of the organisation responsible for the data |
display | S | 1..1 | string | Name of the organisation supplying the data |
implicitRules | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | |
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) | |
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |
Slices for identifier | 1..* | Identifier | An identifier that applies to this person in this role. Slice: Unordered, Open by value:system | |
identifier:All Slices | Content/Rules for all slices | |||
id | 0..0 | |||
identifier:sdsUserID | 0..1 | Identifier | An identifier (sdsUserId) that applies to this person in this role. | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/sds-user-id | |
value | 1..1 | string | The value that is unique | |
assigner | 0..1 | Reference(InterweaveOrganization) | Organization that issued id (may be just text) | |
identifier:sdsRoleProfileID | 0..* | Identifier | An identifier (sdsRoleProfileID) that applies to this person in this role. | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/sds-role-profile-id | |
value | 1..1 | string | The value that is unique | |
assigner | 0..1 | Reference(InterweaveOrganization) | Organization that issued id (may be just text) | |
identifier:gmpNumber | 0..1 | Identifier | An identifier (gmpNumber - General Medical Practitioner) that applies to this person in this role. | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/gmp-number | |
value | 1..1 | string | The value that is unique | |
identifier:gmcNumber | 0..1 | Identifier | An identifier (gmcNumber - General Medical Council / Consultant Code) that applies to this person in this role. | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/gmc-number | |
value | 1..1 | string | The value that is unique | |
identifier:nmcNumber | 0..1 | Identifier | An identifier (nmcNumber - Nursing and Midwifery Council) that applies to this person in this role. | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/nmc-number | |
value | 1..1 | string | The value that is unique | |
identifier:gphcNumber | 0..1 | Identifier | An identifier (gphcNumber - General Pharmaceautical Council Code) that applies to this person in this role. | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/gphc-number | |
value | 1..1 | string | The value that is unique | |
identifier:hcpcNumber | 0..1 | Identifier | An identifier (hcpcNumber - Health and Care Professional Council Code) that applies to this person in this role. | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/hcpc-number | |
value | 1..1 | string | The value that is unique | |
identifier:localIdentifier | 0..1 | Identifier | A local identifier that applies to this person in this role. Please use local identifier at the last resort if none of the other identifiers are not available or as an additional identidier along with others. | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-practitioner-identifier | |
value | 1..1 | string | The value that is unique | |
assigner | 0..1 | Reference(InterweaveOrganization) | Organization that issued id (may be just text) | |
active | S | 0..1 | boolean | Whether this organization is still active - must be both populated and understood if 'false' |
name | 1..1 | HumanName | The name(s) associated with the practitioner. | |
id | 0..0 | |||
extension | 0..0 | |||
text | 0..1 | string | DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements. | |
family | S | 1..1 | string | Family name (often called 'Surname') |
given | S | 0..* | string | Given names (not always 'first'). Includes middle names |
prefix | S | 0..* | string | Parts that come before the name |
suffix | S | 0..* | string | Parts that come after the name |
period | 0..1 | Period | DISCOURAGED: Not relevant as only a single name is permitted | |
telecom | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles). NB these contact details may be widely seen throughout the region. Only work details suitable for receiving external enquires should be included | |
address | 0..* | Address | DISCOURAGED: Addresses should be provided instead on the relevant organisation / location records. For the purposes of regional sharing then practitioner home addresses should NOT be shared. | |
birthDate | 0..0 | |||
photo | 0..0 | |||
qualification | 0..0 | |||
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Practitioner | 0..* | UKCorePractitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |||||
id | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. | ||||
profile | SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource. | ||||
security | Σ | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
Slices for tag | Σ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
tag:Source | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source | ||||
code | SΣ | 1..1 | code | The Data Provider Id of the system supplying the data | ||||
display | SΣ | 1..1 | string | Name of the system supplying the data | ||||
tag:Provenance | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance | ||||
code | SΣ | 1..1 | code | The ODS Code of the organisation responsible for the data | ||||
display | SΣ | 1..1 | string | Name of the organisation supplying the data | ||||
implicitRules | ?!Σ | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | ||||
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣ | 1..* | Identifier | An identifier that applies to this person in this role. Slice: Unordered, Open by value:system | ||||
identifier:All Slices | Content/Rules for all slices | |||||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
identifier:sdsUserID | SΣ | 0..1 | Identifier | An identifier (sdsUserId) 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 . | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/sds-user-id | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
assigner | Σ | 0..1 | Reference(InterweaveOrganization) | Organization that issued id (may be just text) | ||||
identifier:sdsRoleProfileID | SΣ | 0..* | Identifier | An identifier (sdsRoleProfileID) 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 . | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/sds-role-profile-id | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
assigner | Σ | 0..1 | Reference(InterweaveOrganization) | Organization that issued id (may be just text) | ||||
identifier:gmpNumber | SΣ | 0..1 | Identifier | An identifier (gmpNumber - General Medical Practitioner) 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 . | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/gmp-number | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
identifier:gmcNumber | SΣ | 0..1 | Identifier | An identifier (gmcNumber - General Medical Council / Consultant Code) 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 . | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/gmc-number | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
identifier:nmcNumber | SΣ | 0..1 | Identifier | An identifier (nmcNumber - Nursing and Midwifery Council) 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 . | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/nmc-number | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
identifier:gphcNumber | SΣ | 0..1 | Identifier | An identifier (gphcNumber - General Pharmaceautical Council Code) 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 . | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/gphc-number | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
identifier:hcpcNumber | SΣ | 0..1 | Identifier | An identifier (hcpcNumber - Health and Care Professional Council Code) 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 . | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/hcpc-number | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
identifier:localIdentifier | SΣ | 0..1 | Identifier | A local identifier that applies to this person in this role. Please use local identifier at the last resort if none of the other identifiers are not available or as an additional identidier along with others. | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-practitioner-identifier | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
assigner | Σ | 0..1 | Reference(InterweaveOrganization) | Organization that issued id (may be just text) | ||||
active | SΣ | 0..1 | boolean | Whether this organization is still active - must be both populated and understood if 'false' | ||||
name | SΣ | 1..1 | HumanName | The name(s) associated with the practitioner. | ||||
extension | 0..0 | |||||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
text | Σ | 0..1 | string | DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements. | ||||
family | SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
given | SΣ | 0..* | 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 | SΣ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | SΣ | 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 | DISCOURAGED: Not relevant as only a single name is permitted | ||||
telecom | SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles). NB these contact details may be widely seen throughout the region. Only work details suitable for receiving external enquires should be included | ||||
address | Σ | 0..* | Address | DISCOURAGED: Addresses should be provided instead on the relevant organisation / location records. For the purposes of regional sharing then practitioner home addresses should NOT be shared. | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Practitioner.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Practitioner.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Practitioner.meta.tag:Source | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Practitioner.meta.tag:Provenance | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Practitioner.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Practitioner.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:sdsUserID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:sdsRoleProfileID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:gmpNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:gmcNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:nmcNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:gphcNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:hcpcNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:localIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Practitioner.qualification.code | example | v2.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 |
Id | Grade | Path(s) | Details | Requirements |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Practitioner | 0..* | UKCorePractitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |||||
id | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource. | ||||
security | Σ | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
Slices for tag | Σ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
tag:Source | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source | ||||
code | SΣ | 1..1 | code | The Data Provider Id of the system supplying the data | ||||
display | SΣ | 1..1 | string | Name of the system supplying the data | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
tag:Provenance | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance | ||||
code | SΣ | 1..1 | code | The ODS Code of the organisation responsible for the data | ||||
display | SΣ | 1..1 | string | Name of the organisation supplying the data | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
implicitRules | ?!Σ | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | ||||
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣ | 1..* | Identifier | An identifier that applies to this person in this role. Slice: Unordered, Open by value:system | ||||
identifier:All Slices | Content/Rules for all slices | |||||||
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. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..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) | ||||
identifier:sdsUserID | SΣ | 0..1 | Identifier | An identifier (sdsUserId) 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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/sds-user-id | ||||
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(InterweaveOrganization) | Organization that issued id (may be just text) | ||||
identifier:sdsRoleProfileID | SΣ | 0..* | Identifier | An identifier (sdsRoleProfileID) 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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/sds-role-profile-id | ||||
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(InterweaveOrganization) | Organization that issued id (may be just text) | ||||
identifier:gmpNumber | SΣ | 0..1 | Identifier | An identifier (gmpNumber - General Medical Practitioner) 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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/gmp-number | ||||
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) | ||||
identifier:gmcNumber | SΣ | 0..1 | Identifier | An identifier (gmcNumber - General Medical Council / Consultant Code) 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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/gmc-number | ||||
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) | ||||
identifier:nmcNumber | SΣ | 0..1 | Identifier | An identifier (nmcNumber - Nursing and Midwifery Council) 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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/nmc-number | ||||
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) | ||||
identifier:gphcNumber | SΣ | 0..1 | Identifier | An identifier (gphcNumber - General Pharmaceautical Council Code) 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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/gphc-number | ||||
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) | ||||
identifier:hcpcNumber | SΣ | 0..1 | Identifier | An identifier (hcpcNumber - Health and Care Professional Council Code) 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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/id/hcpc-number | ||||
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) | ||||
identifier:localIdentifier | SΣ | 0..1 | Identifier | A local identifier that applies to this person in this role. Please use local identifier at the last resort if none of the other identifiers are not available or as an additional identidier along with others. | ||||
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. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-practitioner-identifier | ||||
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(InterweaveOrganization) | Organization that issued id (may be just text) | ||||
active | SΣ | 0..1 | boolean | Whether this organization is still active - must be both populated and understood if 'false' | ||||
name | SΣ | 1..1 | HumanName | The name(s) associated with the practitioner. | ||||
extension | 0..0 | |||||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
text | Σ | 0..1 | string | DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements. | ||||
family | SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
given | SΣ | 0..* | 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 | SΣ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | SΣ | 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 | DISCOURAGED: Not relevant as only a single name is permitted | ||||
telecom | SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles). NB these contact details may be widely seen throughout the region. Only work details suitable for receiving external enquires should be included | ||||
address | Σ | 0..* | Address | DISCOURAGED: Addresses should be provided instead on the relevant organisation / location records. For the purposes of regional sharing then practitioner home addresses should NOT be shared. | ||||
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
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. | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Practitioner.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Practitioner.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Practitioner.meta.tag:Source | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Practitioner.meta.tag:Provenance | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Practitioner.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Practitioner.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Practitioner.identifier:sdsUserID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:sdsUserID.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Practitioner.identifier:sdsRoleProfileID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:sdsRoleProfileID.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Practitioner.identifier:gmpNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:gmpNumber.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Practitioner.identifier:gmcNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:gmcNumber.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Practitioner.identifier:nmcNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:nmcNumber.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Practitioner.identifier:gphcNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:gphcNumber.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Practitioner.identifier:hcpcNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:hcpcNumber.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Practitioner.identifier:localIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Practitioner.identifier:localIdentifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Practitioner.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Practitioner.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Practitioner.qualification.code | example | v2.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.communication | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages |
Id | Grade | Path(s) | Details | Requirements |
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 UKCorePractitioner
Summary
Mandatory: 3 elements(22 nested mandatory elements)
Must-Support: 15 elements
Fixed: 10 elements
Prohibited: 11 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
Element name | Change details |
---|---|
extension:nhsCommunication |
|
identifier:localIdentifier.system |
|
gender |
|
qualification |
|
communication |
|