HL7 FHIR® UK Core - Local Development build (v4.0.0). See the Directory of published versions
StructureDefinition: UKCorePractitionerRole
Defines the UK Core constraints and extensions on the PractitionerRole resource for the minimal set of data to query and retrieve practitioner role information.
The official URL for this profile is:
https://fhir.nhs.uk/R4/StructureDefinition/UKCore-PractitionerRole
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PractitionerRole
Summary
Mandatory: 0 element (4 nested mandatory elements)
Fixed Value: 1 element
Structures
This structure refers to these other structures:
- https://fhir.nhs.uk/R4/StructureDefinition/UKCore-Organization
- https://fhir.nhs.uk/R4/StructureDefinition/UKCore-Practitioner
- https://fhir.nhs.uk/R4/StructureDefinition/UKCore-Location
Slices
This structure defines the following Slices:
- The element PractitionerRole.code is sliced based on the value of value:coding.system
This structure is derived from PractitionerRole
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  PractitionerRole | 0..* | PractitionerRole | ||
  identifier | ||||
   assigner | 0..1 | Reference(UK Core Organization) | ||
| practitioner | 0..1 | Reference(UK Core Practitioner) | ||
 identifier | ||||
 assigner | 0..1 | Reference(UK Core Organization) | ||
| organization | 0..1 | Reference(UK Core Organization) | ||
| identifier | ||||
| assigner | 0..1 | Reference(UK Core Organization) | ||
 code | 0..* | (Slice Definition) | Slice: Unordered, Open by value:coding.system | |
  code:sdsJobRoleName | 0..1 | CodeableConcept | Binding: UK Core SDS Job Role Name (required) | |
 coding | 1..1 | Coding | ||
 system | 1..1 | uri | Fixed Value: https://fhir.nhs.uk/R4/CodeSystem/UKCore-SDSJobRoleName | |
| code | 1..1 | code | ||
| display | 1..1 | string | ||
| location | 0..* | Reference(UK Core Location) | ||
| identifier | ||||
| assigner | 0..1 | Reference(UK Core Organization) | ||
| healthcareService | ||||
| identifier | ||||
| assigner | 0..1 | Reference(UK Core Organization) | ||
| endpoint | ||||
| identifier | ||||
| assigner | 0..1 | Reference(UK Core Organization) | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole | I | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with |
 id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | Identifier | Business Identifiers that are specific to a role/location |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| active | ΣI | 0..1 | boolean | Whether this practitioner role record is in active use |
| period | ΣI | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
| practitioner | ΣI | 0..1 | Reference(UK Core Practitioner) | Practitioner that is able to provide the defined services for the organization |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| organization | ΣI | 0..1 | Reference(UK Core Organization) | Organization where the roles are available |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| code | ΣI | 0..* | (Slice Definition) | Roles which this practitioner may perform Slice: Unordered, Open by value:coding.system Binding: PractitionerRole (example) |
| code:sdsJobRoleName | ΣI | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: UK Core SDS Job Role Name (required) |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
 coding | ΣI | 1..1 | Coding | Code defined by a terminology system |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | ΣI | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.nhs.uk/R4/CodeSystem/UKCore-SDSJobRoleName |
| version | ΣI | 0..1 | string | Version of the system - if relevant |
| code | ΣI | 1..1 | code | Symbol in syntax defined by the system |
| display | ΣI | 1..1 | string | Representation defined by the system |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user |
 text | ΣI | 0..1 | string | Plain text representation of the concept |
| specialty | ΣI | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred) |
| location | ΣI | 0..* | Reference(UK Core Location) | The location(s) at which this practitioner provides care |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| healthcareService | I | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| telecom | ΣI | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
| availableTime | I | 0..* | BackboneElement | Times the Service Site is available |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| daysOfWeek | I | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) |
| allDay | I | 0..1 | boolean | Always available? e.g. 24 hour service |
| availableStartTime | I | 0..1 | time | Opening time of day (ignored if allDay = true) |
| availableEndTime | I | 0..1 | time | Closing time of day (ignored if allDay = true) |
| notAvailable | I | 0..* | BackboneElement | Not available during this time due to provided reason |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| description | I | 1..1 | string | Reason presented to the user explaining why time not available |
| during | I | 0..1 | Period | Service not available from this date |
| availabilityExceptions | I | 0..1 | string | Description of availability exceptions |
| endpoint | I | 0..* | 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 | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| Documentation for this format | ||||
This structure is derived from PractitionerRole
Summary
Mandatory: 0 element (4 nested mandatory elements)
Fixed Value: 1 element
Structures
This structure refers to these other structures:
- https://fhir.nhs.uk/R4/StructureDefinition/UKCore-Organization
- https://fhir.nhs.uk/R4/StructureDefinition/UKCore-Practitioner
- https://fhir.nhs.uk/R4/StructureDefinition/UKCore-Location
Slices
This structure defines the following Slices:
- The element PractitionerRole.code is sliced based on the value of value:coding.system
Differential View
This structure is derived from PractitionerRole
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole | 0..* | PractitionerRole | ||
| identifier | ||||
| assigner | 0..1 | Reference(UK Core Organization) | ||
| practitioner | 0..1 | Reference(UK Core Practitioner) | ||
| identifier | ||||
| assigner | 0..1 | Reference(UK Core Organization) | ||
| organization | 0..1 | Reference(UK Core Organization) | ||
| identifier | ||||
| assigner | 0..1 | Reference(UK Core Organization) | ||
| code | 0..* | (Slice Definition) | Slice: Unordered, Open by value:coding.system | |
| code:sdsJobRoleName | 0..1 | CodeableConcept | Binding: UK Core SDS Job Role Name (required) | |
| coding | 1..1 | Coding | ||
| system | 1..1 | uri | Fixed Value: https://fhir.nhs.uk/R4/CodeSystem/UKCore-SDSJobRoleName | |
| code | 1..1 | code | ||
| display | 1..1 | string | ||
| location | 0..* | Reference(UK Core Location) | ||
| identifier | ||||
| assigner | 0..1 | Reference(UK Core Organization) | ||
| healthcareService | ||||
| identifier | ||||
| assigner | 0..1 | Reference(UK Core Organization) | ||
| endpoint | ||||
| identifier | ||||
| assigner | 0..1 | Reference(UK Core Organization) | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole | I | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | Identifier | Business Identifiers that are specific to a role/location |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| active | ΣI | 0..1 | boolean | Whether this practitioner role record is in active use |
| period | ΣI | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
| practitioner | ΣI | 0..1 | Reference(UK Core Practitioner) | Practitioner that is able to provide the defined services for the organization |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| organization | ΣI | 0..1 | Reference(UK Core Organization) | Organization where the roles are available |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| code | ΣI | 0..* | (Slice Definition) | Roles which this practitioner may perform Slice: Unordered, Open by value:coding.system Binding: PractitionerRole (example) |
| code:sdsJobRoleName | ΣI | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: UK Core SDS Job Role Name (required) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 1..1 | Coding | Code defined by a terminology system |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | ΣI | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.nhs.uk/R4/CodeSystem/UKCore-SDSJobRoleName |
| version | ΣI | 0..1 | string | Version of the system - if relevant |
| code | ΣI | 1..1 | code | Symbol in syntax defined by the system |
| display | ΣI | 1..1 | string | Representation defined by the system |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user |
| text | ΣI | 0..1 | string | Plain text representation of the concept |
| specialty | ΣI | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred) |
| location | ΣI | 0..* | Reference(UK Core Location) | The location(s) at which this practitioner provides care |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| healthcareService | I | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| telecom | ΣI | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
| availableTime | I | 0..* | BackboneElement | Times the Service Site is available |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| daysOfWeek | I | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) |
| allDay | I | 0..1 | boolean | Always available? e.g. 24 hour service |
| availableStartTime | I | 0..1 | time | Opening time of day (ignored if allDay = true) |
| availableEndTime | I | 0..1 | time | Closing time of day (ignored if allDay = true) |
| notAvailable | I | 0..* | BackboneElement | Not available during this time due to provided reason |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| description | I | 1..1 | string | Reason presented to the user explaining why time not available |
| during | I | 0..1 | Period | Service not available from this date |
| availabilityExceptions | I | 0..1 | string | Description of availability exceptions |
| endpoint | I | 0..* | 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 | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| Documentation for this format | ||||
Other representations of profile: Schematron
Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet |
| PractitionerRole.language | preferred | CommonLanguages Max Binding: AllLanguages |
| PractitionerRole.identifier.use | required | IdentifierUse |
| PractitionerRole.identifier.type | extensible | Identifier Type Codes |
| PractitionerRole.practitioner.type | extensible | ResourceType |
| PractitionerRole.practitioner.identifier.use | required | IdentifierUse |
| PractitionerRole.practitioner.identifier.type | extensible | Identifier Type Codes |
| PractitionerRole.organization.type | extensible | ResourceType |
| PractitionerRole.organization.identifier.use | required | IdentifierUse |
| PractitionerRole.organization.identifier.type | extensible | Identifier Type Codes |
| PractitionerRole.code | example | PractitionerRole |
| PractitionerRole.code:sdsJobRoleName | required | UKCoreSDSJobRoleName |
| PractitionerRole.specialty | preferred | PracticeSettingCodeValueSet |
| PractitionerRole.location.type | extensible | ResourceType |
| PractitionerRole.location.identifier.use | required | IdentifierUse |
| PractitionerRole.location.identifier.type | extensible | Identifier Type Codes |
| PractitionerRole.healthcareService.type | extensible | ResourceType |
| PractitionerRole.healthcareService.identifier.use | required | IdentifierUse |
| PractitionerRole.healthcareService.identifier.type | extensible | Identifier Type Codes |
| PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeek |
| PractitionerRole.endpoint.type | extensible | ResourceType |
| PractitionerRole.endpoint.identifier.use | required | IdentifierUse |
| PractitionerRole.endpoint.identifier.type | extensible | Identifier Type Codes |
Constraints
Constraints
| Id | Path | Details | Requirements |
| dom-2 | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | 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 | 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 | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | PractitionerRole | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | PractitionerRole.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.active | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.practitioner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.practitioner.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.practitioner.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.practitioner.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.practitioner.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.practitioner.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.practitioner.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.practitioner.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.practitioner.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.practitioner.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.practitioner.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.practitioner.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.practitioner.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.practitioner.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.practitioner.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.organization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.organization.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.organization.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.organization.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.organization.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.organization.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.organization.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.organization.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.organization.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.organization.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.organization.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.organization.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.organization.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.organization.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.organization.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.code:sdsJobRoleName | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.code:sdsJobRoleName.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.code:sdsJobRoleName.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.code:sdsJobRoleName.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.code:sdsJobRoleName.coding.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.code:sdsJobRoleName.coding.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.code:sdsJobRoleName.coding.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.code:sdsJobRoleName.coding.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.code:sdsJobRoleName.coding.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.code:sdsJobRoleName.coding.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.code:sdsJobRoleName.coding.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.code:sdsJobRoleName.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.specialty | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.location.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.location.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.location.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.location.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.location.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.location.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.location.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.location.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.location.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.location.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.location.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.location.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.location.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.location.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.healthcareService | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.healthcareService.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.healthcareService.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.healthcareService.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.healthcareService.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.healthcareService.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.healthcareService.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.healthcareService.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.healthcareService.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.healthcareService.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.healthcareService.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.healthcareService.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.healthcareService.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.healthcareService.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.healthcareService.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.availableTime | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.availableTime.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.availableTime.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.availableTime.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.availableTime.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.availableTime.daysOfWeek | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.availableTime.allDay | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.availableTime.availableStartTime | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.availableTime.availableEndTime | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.notAvailable | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.notAvailable.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.notAvailable.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.notAvailable.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.notAvailable.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.notAvailable.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.notAvailable.during | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.availabilityExceptions | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.endpoint | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.endpoint.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.endpoint.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.endpoint.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.endpoint.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.endpoint.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.endpoint.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.endpoint.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.endpoint.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.endpoint.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.endpoint.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.endpoint.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.endpoint.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.endpoint.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.endpoint.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |