BC Provider Location Registry FHIR Implementation Guide
1.0.0 - fhirVersion-4.0; BCPLRVersion=1
BC Provider Location Registry FHIR Implementation Guide
1.0.0 - fhirVersion-4.0; BCPLRVersion=1
BC Provider Location Registry FHIR Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-role-relationships | Version: 1.0.0 | |||
| Active as of 2024-04-28 | Computable Name: BCRoleRelationships | |||
General constraints on the PractitionerRole resource for use in the BC Provider Registry project to describe relationships.
This profile represents the Provider’s relationships to Locations and Organizations. Each BCRoleRelationship must represent one and only one relationship.
This PractitionerRole profile has the following mandatory elements:
Each PractitionerRole must have:
Look in this Bundle for an example of BCRoleRelationship.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PractitionerRoleProfileRegistry
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  PractitionerRole |
C | 0..* | PractitionerRoleProfileRegistry | PractitionerRole Registry Profile invariant-rltn-1: One organization or one location allowed; not both. |
  endReason |
S | 0..1 | CodeableConcept | BC End Reason Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension Binding: BC End Reason Value Set (required) |
| owner |
S | 0..1 | Identifier | BC Owner Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension |
| typeExtension |
S | 0..1 | CodeableConcept | BC Practitioner to Organization or Practitioner to Practitioner Type Extension. URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-relationship-type-extension |
| locRelationshipType |
S | 0..1 | CodeableConcept | BC Practitioner to Location Type Extension. URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-location-relationship-type-extension |
 period |
S | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
 practitioner |
1..1 | Reference(BCPractitioner) | Practitioner that is able to provide the defined services for the organization. | |
 organization |
S | 0..1 | Reference(BCOrganization) | Organization where the roles are available |
  type |
0..0 | |||
| code |
0..0 | |||
| specialty |
0..0 | |||
| location |
S | 0..1 | Reference(BCLocation) | The location(s) at which this practitioner provides care |
 telecom |
0..* | BCContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| invariant-rltn-1 | error | PractitionerRole | One organization or one location allowed; not both. : organization.count()=1 xor location.count()=1 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole |
C | 0..* | PractitionerRoleProfileRegistry | PractitionerRole Registry Profile invariant-rltn-1: One organization or one location allowed; not both. |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| status |
0..1 | code | Role status extension URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-rolestatus Binding: RoleStatus (required) | |
| statusReason |
0..1 | string | Role status reason extension URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-statusreason | |
| endReason |
S | 0..1 | CodeableConcept | BC End Reason Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension Binding: BC End Reason Value Set (required) |
| owner |
S | 0..1 | Identifier | BC Owner Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension |
| typeExtension |
S | 0..1 | CodeableConcept | BC Practitioner to Organization or Practitioner to Practitioner Type Extension. URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-relationship-type-extension |
| locRelationshipType |
S | 0..1 | CodeableConcept | BC Practitioner to Location Type Extension. URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-location-relationship-type-extension |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| period |
SΣ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
| practitioner |
SΣ | 1..1 | Reference(BCPractitioner) | Practitioner that is able to provide the defined services for the organization. |
| organization |
SΣ | 0..1 | Reference(BCOrganization) | Organization where the roles are available |
| location |
SΣ | 0..1 | Reference(BCLocation) | The location(s) at which this practitioner provides care |
 telecom |
SC | 0..* | BCContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) cpt-2: A system is required if a value is provided. |
 system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value |
Σ | 1..1 | string | The actual contact point details |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| PractitionerRole.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| PractitionerRole.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | PractitionerRole.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| 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() | |
| invariant-rltn-1 | error | PractitionerRole | One organization or one location allowed; not both. : organization.count()=1 xor location.count()=1 |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
C | 0..* | PractitionerRoleProfileRegistry | PractitionerRole Registry Profile invariant-rltn-1: One organization or one location allowed; not both. | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| status |
0..1 | code | Role status extension URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-rolestatus Binding: RoleStatus (required) | |||||
| statusReason |
0..1 | string | Role status reason extension URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-statusreason | |||||
| endReason |
S | 0..1 | CodeableConcept | BC End Reason Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension Binding: BC End Reason Value Set (required) | ||||
| owner |
S | 0..1 | Identifier | BC Owner Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension | ||||
| typeExtension |
S | 0..1 | CodeableConcept | BC Practitioner to Organization or Practitioner to Practitioner Type Extension. URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-relationship-type-extension | ||||
| locRelationshipType |
S | 0..1 | CodeableConcept | BC Practitioner to Location Type Extension. URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-location-relationship-type-extension | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | IdentifierCABaseline | An identifier intended for computation | |||||
| active |
Σ | 0..1 | boolean | Whether this practitioner role record is in active use | ||||
| period |
SΣ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||
| practitioner |
SΣ | 1..1 | Reference(BCPractitioner) | Practitioner that is able to provide the defined services for the organization. | ||||
| organization |
SΣ | 0..1 | Reference(BCOrganization) | Organization where the roles are available | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| location |
SΣ | 0..1 | Reference(BCLocation) | The location(s) at which this practitioner provides care | ||||
| healthcareService |
0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |||||
| telecom |
SC | 0..* | BCContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) cpt-2: A system is required if a value is provided. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value |
Σ | 1..1 | string | The actual contact point details | ||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| availableTime |
0..* | BackboneElement | Times the Service Site is available | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| allDay |
0..1 | boolean | Always available? e.g. 24 hour service | |||||
| availableStartTime |
0..1 | time | Opening time of day (ignored if allDay = true) | |||||
| availableEndTime |
0..1 | time | Closing time of day (ignored if allDay = true) | |||||
| notAvailable |
0..* | BackboneElement | Not available during this time due to provided reason | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
1..1 | string | Reason presented to the user explaining why time not available | |||||
| during |
0..1 | Period | Service not available from this date | |||||
| availabilityExceptions |
0..1 | string | Description of availability exceptions | |||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| PractitionerRole.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| PractitionerRole.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| PractitionerRole.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | PractitionerRole.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| 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() | |
| invariant-rltn-1 | error | PractitionerRole | One organization or one location allowed; not both. : organization.count()=1 xor location.count()=1 |
This structure is derived from PractitionerRoleProfileRegistry
Differential View
This structure is derived from PractitionerRoleProfileRegistry
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole |
C | 0..* | PractitionerRoleProfileRegistry | PractitionerRole Registry Profile invariant-rltn-1: One organization or one location allowed; not both. |
| endReason |
S | 0..1 | CodeableConcept | BC End Reason Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension Binding: BC End Reason Value Set (required) |
| owner |
S | 0..1 | Identifier | BC Owner Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension |
| typeExtension |
S | 0..1 | CodeableConcept | BC Practitioner to Organization or Practitioner to Practitioner Type Extension. URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-relationship-type-extension |
| locRelationshipType |
S | 0..1 | CodeableConcept | BC Practitioner to Location Type Extension. URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-location-relationship-type-extension |
| period |
S | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
| practitioner |
1..1 | Reference(BCPractitioner) | Practitioner that is able to provide the defined services for the organization. | |
| organization |
S | 0..1 | Reference(BCOrganization) | Organization where the roles are available |
| type |
0..0 | |||
| code |
0..0 | |||
| specialty |
0..0 | |||
| location |
S | 0..1 | Reference(BCLocation) | The location(s) at which this practitioner provides care |
| telecom |
0..* | BCContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| invariant-rltn-1 | error | PractitionerRole | One organization or one location allowed; not both. : organization.count()=1 xor location.count()=1 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole |
C | 0..* | PractitionerRoleProfileRegistry | PractitionerRole Registry Profile invariant-rltn-1: One organization or one location allowed; not both. |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| status |
0..1 | code | Role status extension URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-rolestatus Binding: RoleStatus (required) | |
| statusReason |
0..1 | string | Role status reason extension URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-statusreason | |
| endReason |
S | 0..1 | CodeableConcept | BC End Reason Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension Binding: BC End Reason Value Set (required) |
| owner |
S | 0..1 | Identifier | BC Owner Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension |
| typeExtension |
S | 0..1 | CodeableConcept | BC Practitioner to Organization or Practitioner to Practitioner Type Extension. URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-relationship-type-extension |
| locRelationshipType |
S | 0..1 | CodeableConcept | BC Practitioner to Location Type Extension. URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-location-relationship-type-extension |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| period |
SΣ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
| practitioner |
SΣ | 1..1 | Reference(BCPractitioner) | Practitioner that is able to provide the defined services for the organization. |
| organization |
SΣ | 0..1 | Reference(BCOrganization) | Organization where the roles are available |
| location |
SΣ | 0..1 | Reference(BCLocation) | The location(s) at which this practitioner provides care |
| telecom |
SC | 0..* | BCContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) cpt-2: A system is required if a value is provided. |
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value |
Σ | 1..1 | string | The actual contact point details |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| PractitionerRole.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| PractitionerRole.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | PractitionerRole.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| 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() | |
| invariant-rltn-1 | error | PractitionerRole | One organization or one location allowed; not both. : organization.count()=1 xor location.count()=1 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
C | 0..* | PractitionerRoleProfileRegistry | PractitionerRole Registry Profile invariant-rltn-1: One organization or one location allowed; not both. | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| status |
0..1 | code | Role status extension URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-rolestatus Binding: RoleStatus (required) | |||||
| statusReason |
0..1 | string | Role status reason extension URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-statusreason | |||||
| endReason |
S | 0..1 | CodeableConcept | BC End Reason Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension Binding: BC End Reason Value Set (required) | ||||
| owner |
S | 0..1 | Identifier | BC Owner Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension | ||||
| typeExtension |
S | 0..1 | CodeableConcept | BC Practitioner to Organization or Practitioner to Practitioner Type Extension. URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-relationship-type-extension | ||||
| locRelationshipType |
S | 0..1 | CodeableConcept | BC Practitioner to Location Type Extension. URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-location-relationship-type-extension | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | IdentifierCABaseline | An identifier intended for computation | |||||
| active |
Σ | 0..1 | boolean | Whether this practitioner role record is in active use | ||||
| period |
SΣ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||
| practitioner |
SΣ | 1..1 | Reference(BCPractitioner) | Practitioner that is able to provide the defined services for the organization. | ||||
| organization |
SΣ | 0..1 | Reference(BCOrganization) | Organization where the roles are available | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| location |
SΣ | 0..1 | Reference(BCLocation) | The location(s) at which this practitioner provides care | ||||
| healthcareService |
0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |||||
| telecom |
SC | 0..* | BCContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) cpt-2: A system is required if a value is provided. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value |
Σ | 1..1 | string | The actual contact point details | ||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| availableTime |
0..* | BackboneElement | Times the Service Site is available | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| allDay |
0..1 | boolean | Always available? e.g. 24 hour service | |||||
| availableStartTime |
0..1 | time | Opening time of day (ignored if allDay = true) | |||||
| availableEndTime |
0..1 | time | Closing time of day (ignored if allDay = true) | |||||
| notAvailable |
0..* | BackboneElement | Not available during this time due to provided reason | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
1..1 | string | Reason presented to the user explaining why time not available | |||||
| during |
0..1 | Period | Service not available from this date | |||||
| availabilityExceptions |
0..1 | string | Description of availability exceptions | |||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| PractitionerRole.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| PractitionerRole.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| PractitionerRole.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | PractitionerRole.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| 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() | |
| invariant-rltn-1 | error | PractitionerRole | One organization or one location allowed; not both. : organization.count()=1 xor location.count()=1 |
This structure is derived from PractitionerRoleProfileRegistry
Other representations of profile: CSV, Excel, Schematron