WOFConnect, published by Service Well AB. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/servicewell/servicewell.fhir.wof-connect/ and changes regularly. See the Directory of published versions
Resource Profile: Wof Connect PractitionerRole
| Official URL: http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-practitionerrole | Version: 0.1.0 | |||
| Active as of 2025-11-27 | Computable Name: WofConnectPractitionerRole | |||
PractitionerRole as exposed by WOF Connect integrations.
Usages:
- Use this Profile: WOF Connect GetScheduleContext Operation Response
- Refer to this Profile: Wof Connect Schedule
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.
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
  PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |||||||||
  id |
SΣ | 1..1 | id | Logical id of this artifact | ||||||||
  meta |
Σ | 1..1 | Meta | Metadata about the resource | ||||||||
  profile |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| active |
SOΣ | 1..1 | boolean | Whether this practitioner role record is in active use
| ||||||||
| period |
SOΣC | 1..1 | Period | The period the practitioner can perform the service Constraints: inv-practitionerrole-period
| ||||||||
| start |
SΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||||||
| end |
SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||||||
 practitioner |
SOΣ | 1..1 | Reference(Wof Connect Practitioner) | The practitioner who performs the service
| ||||||||
| reference |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
| display |
SΣ | 0..1 | string | Text alternative for the resource | ||||||||
| organization |
SOΣ | 0..1 | Reference(Wof Connect Economy Organization) | The organization (e.g. business, cost location) that has the practitioner role
| ||||||||
| reference |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
| display |
SΣ | 0..1 | string | Text alternative for the resource | ||||||||
| code |
SOΣ | 1..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization.
| ||||||||
| healthcareService |
SO | 0..1 | Reference(Wof Connect HealthcareService) | The place (e.g. a clinic) that hosts the practitioner role, if applicable
| ||||||||
| reference |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
| display |
SΣ | 0..1 | string | Text alternative for the resource | ||||||||
 endpoint |
SO | 0..1 | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role
| ||||||||
 reference |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
| Documentation for this format | ||||||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.code | Base | example | Practitioner role | 📍4.0.1 | 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().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()
|
| inv-practitionerrole-period | error | PractitionerRole.period | If present, period.end must be on or after period.start |
end.empty() or start <= end
|
This structure is derived from PractitionerRole
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |||||||||
 id |
S | 1..1 | id | Logical id of this artifact | ||||||||
| meta |
1..1 | Meta | Metadata about the resource | |||||||||
| profile |
1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||||||
| active |
SO | 1..1 | boolean | Whether this practitioner role record is in active use
| ||||||||
| period |
SOC | 1..1 | Period | The period the practitioner can perform the service Constraints: inv-practitionerrole-period
| ||||||||
| start |
S | 1..1 | dateTime | Starting time with inclusive boundary | ||||||||
| end |
S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||||||
| practitioner |
SO | 1..1 | Reference(Wof Connect Practitioner) | The practitioner who performs the service
| ||||||||
| reference |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
| display |
S | 0..1 | string | Text alternative for the resource | ||||||||
| organization |
SO | 0..1 | Reference(Wof Connect Economy Organization) | The organization (e.g. business, cost location) that has the practitioner role
| ||||||||
| reference |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
| display |
S | 0..1 | string | Text alternative for the resource | ||||||||
| code |
SO | 1..* | CodeableConcept | Roles which this practitioner may perform
| ||||||||
| healthcareService |
SO | 0..1 | Reference(Wof Connect HealthcareService) | The place (e.g. a clinic) that hosts the practitioner role, if applicable
| ||||||||
| reference |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
| display |
S | 0..1 | string | Text alternative for the resource | ||||||||
| endpoint |
SO | 0..1 | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role
| ||||||||
| reference |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
| Documentation for this format | ||||||||||||
Constraints
| Id | Grade | Path(s) | Description | Expression |
| inv-practitionerrole-period | error | PractitionerRole.period | If present, period.end must be on or after period.start |
end.empty() or start <= end
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |||||||||
| id |
SΣ | 1..1 | id | Logical id of this artifact | ||||||||
| meta |
Σ | 1..1 | Meta | Metadata about the resource | ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||||||
| profile |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||||||
| 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.
| |||||||||
| 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 |
SOΣ | 1..1 | boolean | Whether this practitioner role record is in active use
| ||||||||
| period |
SOΣC | 1..1 | Period | The period the practitioner can perform the service Constraints: inv-practitionerrole-period
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| start |
SΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||||||
| end |
SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||||||
| practitioner |
SOΣ | 1..1 | Reference(Wof Connect Practitioner) | The practitioner who performs the 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 | |||||||||
| reference |
SΣC | 1..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 |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||
| display |
SΣ | 0..1 | string | Text alternative for the resource | ||||||||
| organization |
SOΣ | 0..1 | Reference(Wof Connect Economy Organization) | The organization (e.g. business, cost location) that has the practitioner role
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| reference |
SΣC | 1..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 |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||
| display |
SΣ | 0..1 | string | Text alternative for the resource | ||||||||
| code |
SOΣ | 1..* | 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: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency. | ||||||||
| location |
Σ | 0..* | Reference(Location) | The location(s) at which this practitioner provides care | ||||||||
| healthcareService |
SO | 0..1 | Reference(Wof Connect HealthcareService) | The place (e.g. a clinic) that hosts the practitioner role, if applicable
| ||||||||
| 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 |
SΣC | 1..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 |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||
| display |
SΣ | 0..1 | string | Text alternative for the resource | ||||||||
| telecom |
Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service | ||||||||
| 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 |
SO | 0..1 | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| reference |
SΣC | 1..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 |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||||||
| Documentation for this format | ||||||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| PractitionerRole.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| PractitionerRole.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| PractitionerRole.practitioner.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| PractitionerRole.organization.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| PractitionerRole.code | Base | example | Practitioner role | 📍4.0.1 | FHIR Std. |
| PractitionerRole.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| PractitionerRole.healthcareService.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| PractitionerRole.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| PractitionerRole.endpoint.type | Base | extensible | ResourceType | 📍4.0.1 | 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().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()
|
| inv-practitionerrole-period | error | PractitionerRole.period | If present, period.end must be on or after period.start |
end.empty() or start <= end
|
This structure is derived from PractitionerRole
Summary
Mandatory: 9 elements(3 nested mandatory elements)
Must-Support: 17 elements
Structures
This structure refers to these other structures:
- Wof Connect Practitioner (http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-practitioner)
- Wof Connect Economy Organization (http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-economyorganization)
- Wof Connect HealthcareService (http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-healthcareservice)
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |||||||||
| id |
SΣ | 1..1 | id | Logical id of this artifact | ||||||||
| meta |
Σ | 1..1 | Meta | Metadata about the resource | ||||||||
| profile |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| active |
SOΣ | 1..1 | boolean | Whether this practitioner role record is in active use
| ||||||||
| period |
SOΣC | 1..1 | Period | The period the practitioner can perform the service Constraints: inv-practitionerrole-period
| ||||||||
| start |
SΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||||||
| end |
SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||||||
| practitioner |
SOΣ | 1..1 | Reference(Wof Connect Practitioner) | The practitioner who performs the service
| ||||||||
| reference |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
| display |
SΣ | 0..1 | string | Text alternative for the resource | ||||||||
| organization |
SOΣ | 0..1 | Reference(Wof Connect Economy Organization) | The organization (e.g. business, cost location) that has the practitioner role
| ||||||||
| reference |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
| display |
SΣ | 0..1 | string | Text alternative for the resource | ||||||||
| code |
SOΣ | 1..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization.
| ||||||||
| healthcareService |
SO | 0..1 | Reference(Wof Connect HealthcareService) | The place (e.g. a clinic) that hosts the practitioner role, if applicable
| ||||||||
| reference |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
| display |
SΣ | 0..1 | string | Text alternative for the resource | ||||||||
| endpoint |
SO | 0..1 | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role
| ||||||||
| reference |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
| Documentation for this format | ||||||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.code | Base | example | Practitioner role | 📍4.0.1 | 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().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()
|
| inv-practitionerrole-period | error | PractitionerRole.period | If present, period.end must be on or after period.start |
end.empty() or start <= end
|
Differential View
This structure is derived from PractitionerRole
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |||||||||
| id |
S | 1..1 | id | Logical id of this artifact | ||||||||
| meta |
1..1 | Meta | Metadata about the resource | |||||||||
| profile |
1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||||||
| active |
SO | 1..1 | boolean | Whether this practitioner role record is in active use
| ||||||||
| period |
SOC | 1..1 | Period | The period the practitioner can perform the service Constraints: inv-practitionerrole-period
| ||||||||
| start |
S | 1..1 | dateTime | Starting time with inclusive boundary | ||||||||
| end |
S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||||||
| practitioner |
SO | 1..1 | Reference(Wof Connect Practitioner) | The practitioner who performs the service
| ||||||||
| reference |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
| display |
S | 0..1 | string | Text alternative for the resource | ||||||||
| organization |
SO | 0..1 | Reference(Wof Connect Economy Organization) | The organization (e.g. business, cost location) that has the practitioner role
| ||||||||
| reference |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
| display |
S | 0..1 | string | Text alternative for the resource | ||||||||
| code |
SO | 1..* | CodeableConcept | Roles which this practitioner may perform
| ||||||||
| healthcareService |
SO | 0..1 | Reference(Wof Connect HealthcareService) | The place (e.g. a clinic) that hosts the practitioner role, if applicable
| ||||||||
| reference |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
| display |
S | 0..1 | string | Text alternative for the resource | ||||||||
| endpoint |
SO | 0..1 | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role
| ||||||||
| reference |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
| Documentation for this format | ||||||||||||
Constraints
| Id | Grade | Path(s) | Description | Expression |
| inv-practitionerrole-period | error | PractitionerRole.period | If present, period.end must be on or after period.start |
end.empty() or start <= end
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |||||||||
| id |
SΣ | 1..1 | id | Logical id of this artifact | ||||||||
| meta |
Σ | 1..1 | Meta | Metadata about the resource | ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||||||
| profile |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||||||
| 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.
| |||||||||
| 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 |
SOΣ | 1..1 | boolean | Whether this practitioner role record is in active use
| ||||||||
| period |
SOΣC | 1..1 | Period | The period the practitioner can perform the service Constraints: inv-practitionerrole-period
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| start |
SΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||||||
| end |
SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||||||
| practitioner |
SOΣ | 1..1 | Reference(Wof Connect Practitioner) | The practitioner who performs the 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 | |||||||||
| reference |
SΣC | 1..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 |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||
| display |
SΣ | 0..1 | string | Text alternative for the resource | ||||||||
| organization |
SOΣ | 0..1 | Reference(Wof Connect Economy Organization) | The organization (e.g. business, cost location) that has the practitioner role
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| reference |
SΣC | 1..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 |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||
| display |
SΣ | 0..1 | string | Text alternative for the resource | ||||||||
| code |
SOΣ | 1..* | 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: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency. | ||||||||
| location |
Σ | 0..* | Reference(Location) | The location(s) at which this practitioner provides care | ||||||||
| healthcareService |
SO | 0..1 | Reference(Wof Connect HealthcareService) | The place (e.g. a clinic) that hosts the practitioner role, if applicable
| ||||||||
| 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 |
SΣC | 1..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 |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||
| display |
SΣ | 0..1 | string | Text alternative for the resource | ||||||||
| telecom |
Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service | ||||||||
| 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 |
SO | 0..1 | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| reference |
SΣC | 1..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 |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||||||
| Documentation for this format | ||||||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| PractitionerRole.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| PractitionerRole.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| PractitionerRole.practitioner.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| PractitionerRole.organization.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| PractitionerRole.code | Base | example | Practitioner role | 📍4.0.1 | FHIR Std. |
| PractitionerRole.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| PractitionerRole.healthcareService.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| PractitionerRole.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| PractitionerRole.endpoint.type | Base | extensible | ResourceType | 📍4.0.1 | 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().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()
|
| inv-practitionerrole-period | error | PractitionerRole.period | If present, period.end must be on or after period.start |
end.empty() or start <= end
|
This structure is derived from PractitionerRole
Summary
Mandatory: 9 elements(3 nested mandatory elements)
Must-Support: 17 elements
Structures
This structure refers to these other structures:
- Wof Connect Practitioner (http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-practitioner)
- Wof Connect Economy Organization (http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-economyorganization)
- Wof Connect HealthcareService (http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-healthcareservice)
Other representations of profile: CSV, Excel, Schematron