HL7 FHIR® UK Core
4.0.0 - CI Build

HL7 FHIR® UK Core - Local Development build (v4.0.0). See the Directory of published versions

StructureDefinition: UKCorePractitioner

Defines the UK Core constraints and extensions on the Practitioner resource for the minimal set of data to query and retrieve practitioner information.

The official URL for this profile is:

https://fhir.nhs.uk/R4/StructureDefinition/UKCore-Practitioner

Formal Views of Profile Content

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

This structure is derived from Practitioner

Summary

Mandatory: 0 element (4 nested mandatory elements)
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Practitioner.identifier is sliced based on the value of value:system
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*(Slice Definition)An identifier for the person as this agent
Slice: Unordered, Open by value:system
.... identifier:sdsUserID ΣI0..1IdentifierAn identifier for the person as this agent
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/sds-user-id
..... value ΣI1..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(UK Core Organization)Organization that issued id (may be just text)
.... identifier:sdsRoleProfileID ΣI0..*IdentifierAn identifier for the person as this agent
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/sds-role-profile-id
..... value ΣI1..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(UK Core Organization)Organization that issued id (may be just text)
... active ΣI0..1booleanWhether this practitioner's record is in active use
... name ΣI0..*HumanNameThe name(s) associated with the practitioner
... telecom ΣI0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address ΣI0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
... gender ΣI0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ΣI0..1dateThe date on which the practitioner was born
... photo I0..*AttachmentImage of the person
... qualification I0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier I0..*IdentifierAn identifier for this qualification for the practitioner
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value ΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(UK Core Organization)Organization that issued id (may be just text)
.... code I1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example)
.... period I0..1PeriodPeriod during which the qualification is valid
.... issuer I0..1Reference(UK Core Organization)Organization that regulates and issues the qualification
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
..... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
..... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
...... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
...... system ΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value ΣI0..1stringThe value that is unique
Example General: 123456
...... period ΣI0..1PeriodTime period when id is/was valid for use
...... assigner ΣI0..1Reference(UK Core Organization)Organization that issued id (may be just text)
..... display ΣI0..1stringText alternative for the resource
... communication I0..*CodeableConceptA language the practitioner can use in patient communication
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages

doco Documentation for this format

This structure is derived from Practitioner

Summary

Mandatory: 0 element (4 nested mandatory elements)
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Practitioner.identifier is sliced based on the value of value:system

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*(Slice Definition)An identifier for the person as this agent
Slice: Unordered, Open by value:system
.... identifier:sdsUserID ΣI0..1IdentifierAn identifier for the person as this agent
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/sds-user-id
..... value ΣI1..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(UK Core Organization)Organization that issued id (may be just text)
.... identifier:sdsRoleProfileID ΣI0..*IdentifierAn identifier for the person as this agent
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/sds-role-profile-id
..... value ΣI1..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(UK Core Organization)Organization that issued id (may be just text)
... active ΣI0..1booleanWhether this practitioner's record is in active use
... name ΣI0..*HumanNameThe name(s) associated with the practitioner
... telecom ΣI0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address ΣI0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
... gender ΣI0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ΣI0..1dateThe date on which the practitioner was born
... photo I0..*AttachmentImage of the person
... qualification I0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier I0..*IdentifierAn identifier for this qualification for the practitioner
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value ΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(UK Core Organization)Organization that issued id (may be just text)
.... code I1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example)
.... period I0..1PeriodPeriod during which the qualification is valid
.... issuer I0..1Reference(UK Core Organization)Organization that regulates and issues the qualification
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
..... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
..... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
...... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
...... system ΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value ΣI0..1stringThe value that is unique
Example General: 123456
...... period ΣI0..1PeriodTime period when id is/was valid for use
...... assigner ΣI0..1Reference(UK Core Organization)Organization that issued id (may be just text)
..... display ΣI0..1stringText alternative for the resource
... communication I0..*CodeableConceptA language the practitioner can use in patient communication
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
Practitioner.languagepreferredCommonLanguages
Max Binding: AllLanguages
Practitioner.identifier:sdsUserID.userequiredIdentifierUse
Practitioner.identifier:sdsUserID.typeextensibleIdentifier Type Codes
Practitioner.identifier:sdsRoleProfileID.userequiredIdentifierUse
Practitioner.identifier:sdsRoleProfileID.typeextensibleIdentifier Type Codes
Practitioner.genderrequiredAdministrativeGender
Practitioner.qualification.identifier.userequiredIdentifierUse
Practitioner.qualification.identifier.typeextensibleIdentifier Type Codes
Practitioner.qualification.codeexamplev2.0360.2.7
Practitioner.qualification.issuer.typeextensibleResourceType
Practitioner.qualification.issuer.identifier.userequiredIdentifierUse
Practitioner.qualification.issuer.identifier.typeextensibleIdentifier Type Codes
Practitioner.communicationpreferredCommonLanguages
Max Binding: AllLanguages

Constraints

Constraints

IdPathDetailsRequirements
dom-2PractitionerIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3PractitionerIf 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-4PractitionerIf 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-5PractitionerIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6PractitionerA resource should have narrative for robust management
: text.`div`.exists()
ele-1Practitioner.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Practitioner.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Practitioner.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:sdsUserIDAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:sdsUserID.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Practitioner.identifier:sdsUserID.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.identifier:sdsUserID.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:sdsUserID.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:sdsUserID.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:sdsUserID.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:sdsUserID.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:sdsUserID.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:sdsRoleProfileIDAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:sdsRoleProfileID.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Practitioner.identifier:sdsRoleProfileID.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.identifier:sdsRoleProfileID.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:sdsRoleProfileID.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:sdsRoleProfileID.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:sdsRoleProfileID.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:sdsRoleProfileID.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:sdsRoleProfileID.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.activeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.genderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.birthDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.photoAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualificationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Practitioner.qualification.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.qualification.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Practitioner.qualification.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.qualification.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.identifier.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Practitioner.qualification.identifier.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.qualification.identifier.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.identifier.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.identifier.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.identifier.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.identifier.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.identifier.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.issuerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.issuer.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Practitioner.qualification.issuer.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.qualification.issuer.referenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.issuer.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.issuer.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.issuer.identifier.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Practitioner.qualification.issuer.identifier.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.qualification.issuer.identifier.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.issuer.identifier.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.issuer.identifier.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.issuer.identifier.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.issuer.identifier.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.issuer.identifier.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.issuer.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.communicationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())