DRAFT Implementation Guide

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

North West Genomics Testing Workflow (GTW) - 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

DRAFT Extension of UKCore PractitionerRole

Usage:

• Refer to this Resource Profile: DocumentReference, Encounter, Observation, ServiceRequest and Specimen
• CapabilityStatements using this Resource Profile: CapabilityStatement for MFT Regional Integration Engine for Genomics

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 UKCorePractitionerRole

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole			UKCorePractitionerRole
practitioner		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
organization		1..1	Reference(Organization)	Organization where the roles are available.
identifier		1..1	OrganisationCode	Logical reference, when literal reference is not known
specialty		0..*	CodeableConcept	Specific specialty of the practitioner. Binding: Specialty (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
PractitionerRole.specialty	required	Specialty https://hl7.mft.nhs.uk/ValueSet/specialty from this IG

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	UKCorePractitionerRole	Roles/organizations the practitioner is associated with dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: 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 dom-6: A resource should have narrative for robust management dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
active	SΣ	0..1	boolean	Whether this practitioner role record is in active use. ele-1: All FHIR elements must have a @value or children
period	SΣC	0..1	Period	The period during which the practitioner is authorized to perform in these role(s). ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end
practitioner	SΣC	1..1	Reference(Practitioner)	Practitioner that is able to provide the defined services for the organization. ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
identifier	Σ	1..1	EnglandPractitionerIdentifier	Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children
organization	SΣC	1..1	Reference(Organization)	Organization where the roles are available. ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
identifier	Σ	1..1	OrganisationCode	Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children
specialty	SΣ	0..*	CodeableConcept	Specific specialty of the practitioner. Binding: Specialty (required) ele-1: All FHIR elements must have a @value or children
location	SΣC	0..*	Reference(Location)	The location(s) at which this practitioner provides care. ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
telecom	SΣC	0..*	ContactPoint	Contact details that are specific to the role/location/service. ele-1: All FHIR elements must have a @value or children cpt-2: A system is required if a value is provided.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PractitionerRole.specialty	required	Specialty https://hl7.mft.nhs.uk/ValueSet/specialty from this IG

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	UKCorePractitionerRole	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
contained		0..*	Resource	Contained, inline Resources
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
identifier	Σ	0..*	Identifier	Business Identifiers that are specific to a role/location
active	SΣ	0..1	boolean	Whether this practitioner role record is in active use.
period	SΣC	0..1	Period	The period during which the practitioner is authorized to perform in these role(s). per-1: If present, start SHALL have a lower value than end
practitioner	SΣC	1..1	Reference(Practitioner)	Practitioner that is able to provide the defined services for the organization. ref-1: SHALL have a contained resource if a local reference is provided
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
display	Σ	0..1	string	Text alternative for the resource
organization	SΣC	1..1	Reference(Organization)	Organization where the roles are available. ref-1: SHALL have a contained resource if a local reference is provided
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
display	Σ	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	SΣ	0..*	CodeableConcept	Specific specialty of the practitioner. Binding: Specialty (required)
location	SΣC	0..*	Reference(Location)	The location(s) at which this practitioner provides care. ref-1: SHALL have a contained resource if a local reference is provided
healthcareService	C	0..*	Reference(HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s) ref-1: SHALL have a contained resource if a local reference is provided
telecom	SΣC	0..*	ContactPoint	Contact details that are specific to the role/location/service. cpt-2: A system is required if a value is provided.
availableTime		0..*	BackboneElement	Times the Service Site is available
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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	C	0..1	Period	Service not available from this date per-1: If present, start SHALL have a lower value than end
availabilityExceptions		0..1	string	Description of availability exceptions
endpoint	C	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role ref-1: SHALL have a contained resource if a local reference is provided
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.organization.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
PractitionerRole.code	example	PractitionerRole http://hl7.org/fhir/ValueSet/practitioner-role from the FHIR Standard
PractitionerRole.specialty	required	Specialty https://hl7.mft.nhs.uk/ValueSet/specialty from this IG
PractitionerRole.availableTime.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

This structure is derived from UKCorePractitionerRole

Summary

Mandatory: 4 elements

Structures

This structure refers to these other structures:

• England Practitioner Identifier (https://hl7.mft.nhs.uk/StructureDefinition/EnglandPractitionerIdentifier)
• Organisation Code (https://hl7.mft.nhs.uk/StructureDefinition/OrganisationCode)

Differential View

This structure is derived from UKCorePractitionerRole

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole			UKCorePractitionerRole
practitioner		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
organization		1..1	Reference(Organization)	Organization where the roles are available.
identifier		1..1	OrganisationCode	Logical reference, when literal reference is not known
specialty		0..*	CodeableConcept	Specific specialty of the practitioner. Binding: Specialty (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
PractitionerRole.specialty	required	Specialty https://hl7.mft.nhs.uk/ValueSet/specialty from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	UKCorePractitionerRole	Roles/organizations the practitioner is associated with dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: 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 dom-6: A resource should have narrative for robust management dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
active	SΣ	0..1	boolean	Whether this practitioner role record is in active use. ele-1: All FHIR elements must have a @value or children
period	SΣC	0..1	Period	The period during which the practitioner is authorized to perform in these role(s). ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end
practitioner	SΣC	1..1	Reference(Practitioner)	Practitioner that is able to provide the defined services for the organization. ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
identifier	Σ	1..1	EnglandPractitionerIdentifier	Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children
organization	SΣC	1..1	Reference(Organization)	Organization where the roles are available. ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
identifier	Σ	1..1	OrganisationCode	Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children
specialty	SΣ	0..*	CodeableConcept	Specific specialty of the practitioner. Binding: Specialty (required) ele-1: All FHIR elements must have a @value or children
location	SΣC	0..*	Reference(Location)	The location(s) at which this practitioner provides care. ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
telecom	SΣC	0..*	ContactPoint	Contact details that are specific to the role/location/service. ele-1: All FHIR elements must have a @value or children cpt-2: A system is required if a value is provided.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PractitionerRole.specialty	required	Specialty https://hl7.mft.nhs.uk/ValueSet/specialty from this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	UKCorePractitionerRole	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
contained		0..*	Resource	Contained, inline Resources
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
identifier	Σ	0..*	Identifier	Business Identifiers that are specific to a role/location
active	SΣ	0..1	boolean	Whether this practitioner role record is in active use.
period	SΣC	0..1	Period	The period during which the practitioner is authorized to perform in these role(s). per-1: If present, start SHALL have a lower value than end
practitioner	SΣC	1..1	Reference(Practitioner)	Practitioner that is able to provide the defined services for the organization. ref-1: SHALL have a contained resource if a local reference is provided
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
display	Σ	0..1	string	Text alternative for the resource
organization	SΣC	1..1	Reference(Organization)	Organization where the roles are available. ref-1: SHALL have a contained resource if a local reference is provided
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
display	Σ	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	SΣ	0..*	CodeableConcept	Specific specialty of the practitioner. Binding: Specialty (required)
location	SΣC	0..*	Reference(Location)	The location(s) at which this practitioner provides care. ref-1: SHALL have a contained resource if a local reference is provided
healthcareService	C	0..*	Reference(HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s) ref-1: SHALL have a contained resource if a local reference is provided
telecom	SΣC	0..*	ContactPoint	Contact details that are specific to the role/location/service. cpt-2: A system is required if a value is provided.
availableTime		0..*	BackboneElement	Times the Service Site is available
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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	C	0..1	Period	Service not available from this date per-1: If present, start SHALL have a lower value than end
availabilityExceptions		0..1	string	Description of availability exceptions
endpoint	C	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role ref-1: SHALL have a contained resource if a local reference is provided
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.organization.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
PractitionerRole.code	example	PractitionerRole http://hl7.org/fhir/ValueSet/practitioner-role from the FHIR Standard
PractitionerRole.specialty	required	Specialty https://hl7.mft.nhs.uk/ValueSet/specialty from this IG
PractitionerRole.availableTime.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

This structure is derived from UKCorePractitionerRole

Summary

Mandatory: 4 elements

Structures

This structure refers to these other structures:

• England Practitioner Identifier (https://hl7.mft.nhs.uk/StructureDefinition/EnglandPractitionerIdentifier)
• Organisation Code (https://hl7.mft.nhs.uk/StructureDefinition/OrganisationCode)

Other representations of profile: CSV, Excel, Schematron