HL7 Europe Base and Core FHIR IG
0.1.0-ci-build - ci-build 150

HL7 Europe Base and Core FHIR IG, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.1.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/base-r5/ and changes regularly. See the Directory of published versions

Resource Profile: PractitionerRole (EU base)

Official URL: http://hl7.eu/fhir/base-r5/StructureDefinition/practitionerRole-eu Version: 0.1.0-ci-build
Standards status: Draft Maturity Level: 2 Computable Name: PractitionerRoleEu

Copyright/Legal: Copyright HL7 Europe. Licensed under creative commons public domain (CC0 1.0).

This profile specifies how the HL7 FHIR PractitionerRole resource should be used for conveying commonly used concepts in the European context.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* PractitionerRole Roles/organizations the practitioner is associated with
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... practitioner Σ 0..1 Reference(Practitioner) The practitioner providing services for the organization
... organization Σ 0..1 Reference(Organization) The organization where the practitioner performs the role
... code Σ 0..* CodeableConcept Roles which this practitioner may perform.
Binding: PractitionerRole (example): The role a person plays representing an organization.
... specialty Σ 0..* CodeableConcept Specialty of the practitioner
Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
... location Σ 0..* Reference(Location) The location(s) at which this practitioner provides care
... contact 0..* ExtendedContactDetail Official contact details relating to this practitioner role

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PractitionerRole.code Base example Practitioner Role 📍5.0.0 FHIR Std.
PractitionerRole.specialty Base preferred Practice Setting Code Value Set 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* PractitionerRole Roles/organizations the practitioner is associated with
... identifier 0..* Identifier Business identifier
... practitioner 0..1 Reference(Practitioner) The practitioner providing services for the organization
... organization 0..1 Reference(Organization) The organization where the practitioner performs the role
... specialty 0..* CodeableConcept Specialty of the practitioner
... location 0..* Reference(Location) The location(s) at which this practitioner provides care
... contact 0..* ExtendedContactDetail Official contact details relating to this practitioner role

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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 identifier
... 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 Σ 0..1 Reference(Practitioner) The practitioner providing services for the organization
... organization Σ 0..1 Reference(Organization) The organization where the practitioner performs the role
... code Σ 0..* CodeableConcept Roles which this practitioner may perform.
Binding: PractitionerRole (example): The role a person plays representing an organization.
... specialty Σ 0..* CodeableConcept Specialty of the practitioner
Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
... location Σ 0..* Reference(Location) The location(s) at which this practitioner provides care
... healthcareService 0..* Reference(HealthcareService) Healthcare services provided for this role's Organization/Location(s)
... contact 0..* ExtendedContactDetail Official contact details relating to this practitioner role
... characteristic 0..* CodeableConcept Collection of characteristics (attributes)
Binding: ServiceMode (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibility).
... communication 0..* CodeableConcept A language the practitioner (in this role) can use in patient communication
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter

... availability 0..* Availability Times the Practitioner is available at this location and/or healthcare service (including exceptions)
... endpoint 0..* Reference(Endpoint) Endpoints for interacting with the practitioner in this role

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PractitionerRole.language Base required All Languages 📍5.0.0 FHIR Std.
PractitionerRole.code Base example Practitioner Role 📍5.0.0 FHIR Std.
PractitionerRole.specialty Base preferred Practice Setting Code Value Set 📍5.0.0 FHIR Std.
PractitionerRole.characteristic Base example Service Mode 📍5.0.0 FHIR Std.
PractitionerRole.communication Base required All Languages 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* PractitionerRole Roles/organizations the practitioner is associated with
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... practitioner Σ 0..1 Reference(Practitioner) The practitioner providing services for the organization
... organization Σ 0..1 Reference(Organization) The organization where the practitioner performs the role
... code Σ 0..* CodeableConcept Roles which this practitioner may perform.
Binding: PractitionerRole (example): The role a person plays representing an organization.
... specialty Σ 0..* CodeableConcept Specialty of the practitioner
Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
... location Σ 0..* Reference(Location) The location(s) at which this practitioner provides care
... contact 0..* ExtendedContactDetail Official contact details relating to this practitioner role

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PractitionerRole.code Base example Practitioner Role 📍5.0.0 FHIR Std.
PractitionerRole.specialty Base preferred Practice Setting Code Value Set 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()

Differential View

This structure is derived from PractitionerRole

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* PractitionerRole Roles/organizations the practitioner is associated with
... identifier 0..* Identifier Business identifier
... practitioner 0..1 Reference(Practitioner) The practitioner providing services for the organization
... organization 0..1 Reference(Organization) The organization where the practitioner performs the role
... specialty 0..* CodeableConcept Specialty of the practitioner
... location 0..* Reference(Location) The location(s) at which this practitioner provides care
... contact 0..* ExtendedContactDetail Official contact details relating to this practitioner role

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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 identifier
... 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 Σ 0..1 Reference(Practitioner) The practitioner providing services for the organization
... organization Σ 0..1 Reference(Organization) The organization where the practitioner performs the role
... code Σ 0..* CodeableConcept Roles which this practitioner may perform.
Binding: PractitionerRole (example): The role a person plays representing an organization.
... specialty Σ 0..* CodeableConcept Specialty of the practitioner
Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
... location Σ 0..* Reference(Location) The location(s) at which this practitioner provides care
... healthcareService 0..* Reference(HealthcareService) Healthcare services provided for this role's Organization/Location(s)
... contact 0..* ExtendedContactDetail Official contact details relating to this practitioner role
... characteristic 0..* CodeableConcept Collection of characteristics (attributes)
Binding: ServiceMode (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibility).
... communication 0..* CodeableConcept A language the practitioner (in this role) can use in patient communication
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter

... availability 0..* Availability Times the Practitioner is available at this location and/or healthcare service (including exceptions)
... endpoint 0..* Reference(Endpoint) Endpoints for interacting with the practitioner in this role

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PractitionerRole.language Base required All Languages 📍5.0.0 FHIR Std.
PractitionerRole.code Base example Practitioner Role 📍5.0.0 FHIR Std.
PractitionerRole.specialty Base preferred Practice Setting Code Value Set 📍5.0.0 FHIR Std.
PractitionerRole.characteristic Base example Service Mode 📍5.0.0 FHIR Std.
PractitionerRole.communication Base required All Languages 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron