DRAFT Implementation Guide

This is for collaboration and discussion purposes and is subject to change.

North West Genomic Medicine Service Alliance - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Examples
• XML
• JSON

Resource Profile: PractitionerRole

TODO

Usages:

• Refer to this Profile: Diagnostic Report, DocumentReference, Observation Diagnostic Implication, Observation Variant... Show 2 more, ServiceRequest and Specimen

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from PractitionerRole

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PractitionerRole			PractitionerRole
practitioner	S	1..1	Reference(Practitioner)	Practitioner that is able to provide the defined services for the organization
identifier		1..1	EnglandPractitionerIdentifier	Logical reference, when literal reference is not known
value	S	1..1	string	The value that is unique
display	S	0..1	string	Text alternative for the resource
organization	S	1..1	Reference(Organization)	Organization where the roles are available
identifier		1..1	OrganisationCode	Logical reference, when literal reference is not known
value	S	1..1	string	The value that is unique
display	S	0..1	string	Text alternative for the resource
specialty		0..*	CodeableConcept	Specific specialty of the practitioner Binding: Specialty (required)
telecom
value	S	0..1	string	The actual contact point details
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
PractitionerRole.specialty	required	Specialty https://nw-gmsa.github.io/ValueSet/specialty From this IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PractitionerRole		0..*	PractitionerRole	Roles/organizations the practitioner is associated with
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
practitioner	SΣ	1..1	Reference(Practitioner)	Practitioner that is able to provide the defined services for the organization
identifier	Σ	1..1	EnglandPractitionerIdentifier	Logical reference, when literal reference is not known
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 Binding: Practitioner Identifiers (required) Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
organization	SΣ	1..1	Reference(Organization)	Organization where the roles are available
identifier	Σ	1..1	OrganisationCode	Logical reference, when literal reference is not known
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/ods-organization-code
value	SΣ	1..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
specialty	Σ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: Specialty (required)
telecom	Σ	0..*	ContactPoint	Contact details that are specific to the role/location/service
value	SΣ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PractitionerRole.practitioner.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
PractitionerRole.practitioner.identifier.system	required	PractitionerIdentifiers(a valid code from UK Professional License) https://nw-gmsa.github.io/ValueSet/PractitionerIdentifiers From this IG
PractitionerRole.organization.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
PractitionerRole.specialty	required	Specialty https://nw-gmsa.github.io/ValueSet/specialty From this IG
PractitionerRole.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	PractitionerRole	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	PractitionerRole	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	PractitionerRole	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	PractitionerRole	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PractitionerRole	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    Filter: Bindings Constraints Obligations
PractitionerRole		0..*	PractitionerRole	Roles/organizations the practitioner is associated with
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business Identifiers that are specific to a role/location
active	Σ	0..1	boolean	Whether this practitioner role record is in active use
period	Σ	0..1	Period	The period during which the practitioner is authorized to perform in these role(s)
practitioner	SΣ	1..1	Reference(Practitioner)	Practitioner that is able to provide the defined services for the organization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	1..1	EnglandPractitionerIdentifier	Logical reference, when literal reference is not known
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.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system Fixed Value: As shown (License number)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: LN
display		0..0	string	Representation defined by the system
userSelected		0..0	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	1..1	uri	The namespace for the identifier value Binding: Practitioner Identifiers (required) Example General: http://www.acme.com/identifiers/patient
value	SΣ	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)
display	SΣ	0..1	string	Text alternative for the resource
organization	SΣ	1..1	Reference(Organization)	Organization where the roles are available
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	1..1	OrganisationCode	Logical reference, when literal reference is not known
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/ods-organization-code
value	SΣ	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)
display	SΣ	0..1	string	Text alternative for the resource
code	Σ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization.
specialty	Σ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: Specialty (required)
location	Σ	0..*	Reference(Location)	The location(s) at which this practitioner provides care
healthcareService		0..*	Reference(HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom	Σ	0..*	ContactPoint	Contact details that are specific to the role/location/service
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
availableTime		0..*	BackboneElement	Times the Service Site is available
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
daysOfWeek		0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay		0..1	boolean	Always available? e.g. 24 hour service
availableStartTime		0..1	time	Opening time of day (ignored if allDay = true)
availableEndTime		0..1	time	Closing time of day (ignored if allDay = true)
notAvailable		0..*	BackboneElement	Not available during this time due to provided reason
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
description		1..1	string	Reason presented to the user explaining why time not available
during		0..1	Period	Service not available from this date
availabilityExceptions		0..1	string	Description of availability exceptions
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PractitionerRole.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
PractitionerRole.practitioner.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
PractitionerRole.practitioner.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
PractitionerRole.practitioner.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
PractitionerRole.practitioner.identifier.system	required	PractitionerIdentifiers(a valid code from UK Professional License) https://nw-gmsa.github.io/ValueSet/PractitionerIdentifiers From this IG
PractitionerRole.organization.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
PractitionerRole.organization.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
PractitionerRole.organization.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
PractitionerRole.code	example	PractitionerRole http://hl7.org/fhir/ValueSet/practitioner-role From the FHIR Standard
PractitionerRole.specialty	required	Specialty https://nw-gmsa.github.io/ValueSet/specialty From this IG
PractitionerRole.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard
PractitionerRole.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard
PractitionerRole.availableTime.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	PractitionerRole	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	PractitionerRole	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	PractitionerRole	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	PractitionerRole	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PractitionerRole	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 PractitionerRole

Summary

Mandatory: 4 elements
Must-Support: 7 elements

Structures

This structure refers to these other structures:

• England Practitioner Identifier (https://nw-gmsa.github.io/StructureDefinition/EnglandPractitionerIdentifier)
• Organisation Code (https://nw-gmsa.github.io/StructureDefinition/OrganisationCode)

Differential View

This structure is derived from PractitionerRole

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PractitionerRole			PractitionerRole
practitioner	S	1..1	Reference(Practitioner)	Practitioner that is able to provide the defined services for the organization
identifier		1..1	EnglandPractitionerIdentifier	Logical reference, when literal reference is not known
value	S	1..1	string	The value that is unique
display	S	0..1	string	Text alternative for the resource
organization	S	1..1	Reference(Organization)	Organization where the roles are available
identifier		1..1	OrganisationCode	Logical reference, when literal reference is not known
value	S	1..1	string	The value that is unique
display	S	0..1	string	Text alternative for the resource
specialty		0..*	CodeableConcept	Specific specialty of the practitioner Binding: Specialty (required)
telecom
value	S	0..1	string	The actual contact point details
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
PractitionerRole.specialty	required	Specialty https://nw-gmsa.github.io/ValueSet/specialty From this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PractitionerRole		0..*	PractitionerRole	Roles/organizations the practitioner is associated with
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
practitioner	SΣ	1..1	Reference(Practitioner)	Practitioner that is able to provide the defined services for the organization
identifier	Σ	1..1	EnglandPractitionerIdentifier	Logical reference, when literal reference is not known
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 Binding: Practitioner Identifiers (required) Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
organization	SΣ	1..1	Reference(Organization)	Organization where the roles are available
identifier	Σ	1..1	OrganisationCode	Logical reference, when literal reference is not known
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/ods-organization-code
value	SΣ	1..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
specialty	Σ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: Specialty (required)
telecom	Σ	0..*	ContactPoint	Contact details that are specific to the role/location/service
value	SΣ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PractitionerRole.practitioner.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
PractitionerRole.practitioner.identifier.system	required	PractitionerIdentifiers(a valid code from UK Professional License) https://nw-gmsa.github.io/ValueSet/PractitionerIdentifiers From this IG
PractitionerRole.organization.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
PractitionerRole.specialty	required	Specialty https://nw-gmsa.github.io/ValueSet/specialty From this IG
PractitionerRole.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	PractitionerRole	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	PractitionerRole	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	PractitionerRole	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	PractitionerRole	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PractitionerRole	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    Filter: Bindings Constraints Obligations
PractitionerRole		0..*	PractitionerRole	Roles/organizations the practitioner is associated with
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business Identifiers that are specific to a role/location
active	Σ	0..1	boolean	Whether this practitioner role record is in active use
period	Σ	0..1	Period	The period during which the practitioner is authorized to perform in these role(s)
practitioner	SΣ	1..1	Reference(Practitioner)	Practitioner that is able to provide the defined services for the organization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	1..1	EnglandPractitionerIdentifier	Logical reference, when literal reference is not known
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.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system Fixed Value: As shown (License number)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: LN
display		0..0	string	Representation defined by the system
userSelected		0..0	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	1..1	uri	The namespace for the identifier value Binding: Practitioner Identifiers (required) Example General: http://www.acme.com/identifiers/patient
value	SΣ	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)
display	SΣ	0..1	string	Text alternative for the resource
organization	SΣ	1..1	Reference(Organization)	Organization where the roles are available
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	1..1	OrganisationCode	Logical reference, when literal reference is not known
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/ods-organization-code
value	SΣ	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)
display	SΣ	0..1	string	Text alternative for the resource
code	Σ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization.
specialty	Σ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: Specialty (required)
location	Σ	0..*	Reference(Location)	The location(s) at which this practitioner provides care
healthcareService		0..*	Reference(HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom	Σ	0..*	ContactPoint	Contact details that are specific to the role/location/service
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
availableTime		0..*	BackboneElement	Times the Service Site is available
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
daysOfWeek		0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay		0..1	boolean	Always available? e.g. 24 hour service
availableStartTime		0..1	time	Opening time of day (ignored if allDay = true)
availableEndTime		0..1	time	Closing time of day (ignored if allDay = true)
notAvailable		0..*	BackboneElement	Not available during this time due to provided reason
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
description		1..1	string	Reason presented to the user explaining why time not available
during		0..1	Period	Service not available from this date
availabilityExceptions		0..1	string	Description of availability exceptions
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PractitionerRole.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
PractitionerRole.practitioner.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
PractitionerRole.practitioner.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
PractitionerRole.practitioner.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
PractitionerRole.practitioner.identifier.system	required	PractitionerIdentifiers(a valid code from UK Professional License) https://nw-gmsa.github.io/ValueSet/PractitionerIdentifiers From this IG
PractitionerRole.organization.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
PractitionerRole.organization.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
PractitionerRole.organization.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
PractitionerRole.code	example	PractitionerRole http://hl7.org/fhir/ValueSet/practitioner-role From the FHIR Standard
PractitionerRole.specialty	required	Specialty https://nw-gmsa.github.io/ValueSet/specialty From this IG
PractitionerRole.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard
PractitionerRole.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard
PractitionerRole.availableTime.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	PractitionerRole	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	PractitionerRole	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	PractitionerRole	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	PractitionerRole	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PractitionerRole	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 PractitionerRole

Summary

Mandatory: 4 elements
Must-Support: 7 elements

Structures

This structure refers to these other structures:

• England Practitioner Identifier (https://nw-gmsa.github.io/StructureDefinition/EnglandPractitionerIdentifier)
• Organisation Code (https://nw-gmsa.github.io/StructureDefinition/OrganisationCode)

Other representations of profile: CSV, Excel, Schematron