US Public Health Profiles Library
2.0.0 -
US Public Health Profiles Library, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ph-library/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-practitionerrole | Version: 2.0.0 | |||
| Standards status: Trial-use Active as of 2025-10-23 | Maturity Level: 3 | Computable Name: USPublicHealthPractitionerRole | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.58.42.44 | ||||
This PractitionerRole profile represents the roles and organizations of the practitioner.
It is based on the US Core PractitionerRole profile with a further restriction of mandatory practitioner and telecom data elements and US Public Health Location and US Public Health Organization references.
| Use Case | Data Class | Data Element Name |
|---|---|---|
| Case Reporting | Care Team Member(s) | Provider Address |
| Case Reporting | Care Team Member(s) | Provider Email |
| Case Reporting | Care Team Member(s) | Provider Fax |
| Case Reporting | Care Team Member(s) | Provider Name |
| Case Reporting | Care Team Member(s) | Provider NPI |
| Case Reporting | Care Team Member(s) | Provider Phone |
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | USCorePractitionerRoleProfile(6.1.0) | US Public Health PractitionerRole Constraints: pd-1, us-core-13 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
SΣC | 1..1 | Reference(US Core Practitioner Profile(6.1.0)) | (USCDI+) Provider Address, (USCDI+) Provider Email, (USCDI+) Provider Fax, (USCDI+) Provider Name, (USCDI+) Provider NPI, (USCDI+) Provider Phone (contained in referenced US Core Practitioner) |
![]() ![]() |
SΣC | 0..1 | Reference(US Public Health Organization(2.0.0)) | Organization where the roles are available |
![]() ![]() |
SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: CareTeamMemberFunction (20240605) (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc. |
![]() ![]() |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: HealthcareProviderTaxonomy (20240606) (extensible) |
![]() ![]() |
SΣC | 0..* | Reference(US Public Health Location(2.0.0)) | The location(s) at which this practitioner provides care |
![]() ![]() |
SΣC | 1..* | ContactPoint | Contact details that are specific to the role/location/service |
![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() |
SC | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.code | Base | extensible |
Care Team Member Function
|
📍20240605 | VSAC v0.23 |
| PractitionerRole.specialty | Base | extensible |
Healthcare Provider Taxonomy
|
📍20240606 | VSAC v0.23 |
| PractitionerRole.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| PractitionerRole.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| 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 | PractitionerRole.implicitRules, PractitionerRole.modifierExtension, PractitionerRole.practitioner, PractitionerRole.organization, PractitionerRole.code, PractitionerRole.specialty, PractitionerRole.location, PractitionerRole.telecom, PractitionerRole.telecom.system, PractitionerRole.telecom.value, PractitionerRole.telecom.use, PractitionerRole.endpoint | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | PractitionerRole.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| pd-1 | error | PractitionerRole | SHALL have contact information or a reference to an Endpoint |
telecom or endpoint
|
| us-core-13 | error | PractitionerRole | SHALL have a practitioner, an organization, a healthcare service, or a location. |
practitioner or organization or healthcareService or location
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | USCorePractitionerRoleProfile(6.1.0) | US Public Health PractitionerRole | |
![]() ![]() |
1..1 | Reference(US Core Practitioner Profile(6.1.0)) | (USCDI+) Provider Address, (USCDI+) Provider Email, (USCDI+) Provider Fax, (USCDI+) Provider Name, (USCDI+) Provider NPI, (USCDI+) Provider Phone (contained in referenced US Core Practitioner) | |
![]() ![]() |
0..1 | Reference(US Public Health Organization(2.0.0)) | Organization where the roles are available | |
![]() ![]() |
0..* | Reference(US Public Health Location(2.0.0)) | The location(s) at which this practitioner provides care | |
![]() ![]() |
1..* | ContactPoint | Contact details that are specific to the role/location/service | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | USCorePractitionerRoleProfile(6.1.0) | US Public Health PractitionerRole Constraints: pd-1, us-core-13 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location | ||||
![]() ![]() |
Σ | 0..1 | boolean | Whether this practitioner role record is in active use | ||||
![]() ![]() |
Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||
![]() ![]() |
SΣC | 1..1 | Reference(US Core Practitioner Profile(6.1.0)) | (USCDI+) Provider Address, (USCDI+) Provider Email, (USCDI+) Provider Fax, (USCDI+) Provider Name, (USCDI+) Provider NPI, (USCDI+) Provider Phone (contained in referenced US Core Practitioner) | ||||
![]() ![]() |
SΣC | 0..1 | Reference(US Public Health Organization(2.0.0)) | Organization where the roles are available | ||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: CareTeamMemberFunction (20240605) (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc. | ||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: HealthcareProviderTaxonomy (20240606) (extensible) | ||||
![]() ![]() |
SΣC | 0..* | Reference(US Public Health Location(2.0.0)) | The location(s) at which this practitioner provides care | ||||
![]() ![]() |
C | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | ||||
![]() ![]() |
SΣC | 1..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() |
0..* | BackboneElement | Times the Service Site is available | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
![]() ![]() ![]() |
0..1 | boolean | Always available? e.g. 24 hour service | |||||
![]() ![]() ![]() |
0..1 | time | Opening time of day (ignored if allDay = true) | |||||
![]() ![]() ![]() |
0..1 | time | Closing time of day (ignored if allDay = true) | |||||
![]() ![]() |
0..* | BackboneElement | Not available during this time due to provided reason | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
1..1 | string | Reason presented to the user explaining why time not available | |||||
![]() ![]() ![]() |
0..1 | Period | Service not available from this date | |||||
![]() ![]() |
0..1 | string | Description of availability exceptions | |||||
![]() ![]() |
SC | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| PractitionerRole.code | Base | extensible |
Care Team Member Function
|
📍20240605 | VSAC v0.23 |
| PractitionerRole.specialty | Base | extensible |
Healthcare Provider Taxonomy
|
📍20240606 | VSAC v0.23 |
| PractitionerRole.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| PractitionerRole.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| PractitionerRole.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| 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 | PractitionerRole.meta, PractitionerRole.implicitRules, PractitionerRole.language, PractitionerRole.text, PractitionerRole.extension, PractitionerRole.modifierExtension, PractitionerRole.identifier, PractitionerRole.active, PractitionerRole.period, PractitionerRole.practitioner, PractitionerRole.organization, PractitionerRole.code, PractitionerRole.specialty, PractitionerRole.location, PractitionerRole.healthcareService, PractitionerRole.telecom, PractitionerRole.telecom.extension, PractitionerRole.telecom.system, PractitionerRole.telecom.value, PractitionerRole.telecom.use, PractitionerRole.telecom.rank, PractitionerRole.telecom.period, PractitionerRole.availableTime, PractitionerRole.availableTime.extension, PractitionerRole.availableTime.modifierExtension, PractitionerRole.availableTime.daysOfWeek, PractitionerRole.availableTime.allDay, PractitionerRole.availableTime.availableStartTime, PractitionerRole.availableTime.availableEndTime, PractitionerRole.notAvailable, PractitionerRole.notAvailable.extension, PractitionerRole.notAvailable.modifierExtension, PractitionerRole.notAvailable.description, PractitionerRole.notAvailable.during, PractitionerRole.availabilityExceptions, PractitionerRole.endpoint | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | PractitionerRole.extension, PractitionerRole.modifierExtension, PractitionerRole.telecom.extension, PractitionerRole.availableTime.extension, PractitionerRole.availableTime.modifierExtension, PractitionerRole.notAvailable.extension, PractitionerRole.notAvailable.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| pd-1 | error | PractitionerRole | SHALL have contact information or a reference to an Endpoint |
telecom or endpoint
|
| us-core-13 | error | PractitionerRole | SHALL have a practitioner, an organization, a healthcare service, or a location. |
practitioner or organization or healthcareService or location
|
Summary
Mandatory: 2 elements
Structures
This structure refers to these other structures:
Maturity: 3
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | USCorePractitionerRoleProfile(6.1.0) | US Public Health PractitionerRole Constraints: pd-1, us-core-13 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
SΣC | 1..1 | Reference(US Core Practitioner Profile(6.1.0)) | (USCDI+) Provider Address, (USCDI+) Provider Email, (USCDI+) Provider Fax, (USCDI+) Provider Name, (USCDI+) Provider NPI, (USCDI+) Provider Phone (contained in referenced US Core Practitioner) |
![]() ![]() |
SΣC | 0..1 | Reference(US Public Health Organization(2.0.0)) | Organization where the roles are available |
![]() ![]() |
SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: CareTeamMemberFunction (20240605) (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc. |
![]() ![]() |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: HealthcareProviderTaxonomy (20240606) (extensible) |
![]() ![]() |
SΣC | 0..* | Reference(US Public Health Location(2.0.0)) | The location(s) at which this practitioner provides care |
![]() ![]() |
SΣC | 1..* | ContactPoint | Contact details that are specific to the role/location/service |
![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() |
SC | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.code | Base | extensible |
Care Team Member Function
|
📍20240605 | VSAC v0.23 |
| PractitionerRole.specialty | Base | extensible |
Healthcare Provider Taxonomy
|
📍20240606 | VSAC v0.23 |
| PractitionerRole.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| PractitionerRole.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| 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 | PractitionerRole.implicitRules, PractitionerRole.modifierExtension, PractitionerRole.practitioner, PractitionerRole.organization, PractitionerRole.code, PractitionerRole.specialty, PractitionerRole.location, PractitionerRole.telecom, PractitionerRole.telecom.system, PractitionerRole.telecom.value, PractitionerRole.telecom.use, PractitionerRole.endpoint | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | PractitionerRole.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| pd-1 | error | PractitionerRole | SHALL have contact information or a reference to an Endpoint |
telecom or endpoint
|
| us-core-13 | error | PractitionerRole | SHALL have a practitioner, an organization, a healthcare service, or a location. |
practitioner or organization or healthcareService or location
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | USCorePractitionerRoleProfile(6.1.0) | US Public Health PractitionerRole | |
![]() ![]() |
1..1 | Reference(US Core Practitioner Profile(6.1.0)) | (USCDI+) Provider Address, (USCDI+) Provider Email, (USCDI+) Provider Fax, (USCDI+) Provider Name, (USCDI+) Provider NPI, (USCDI+) Provider Phone (contained in referenced US Core Practitioner) | |
![]() ![]() |
0..1 | Reference(US Public Health Organization(2.0.0)) | Organization where the roles are available | |
![]() ![]() |
0..* | Reference(US Public Health Location(2.0.0)) | The location(s) at which this practitioner provides care | |
![]() ![]() |
1..* | ContactPoint | Contact details that are specific to the role/location/service | |
Documentation for this format | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | USCorePractitionerRoleProfile(6.1.0) | US Public Health PractitionerRole Constraints: pd-1, us-core-13 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location | ||||
![]() ![]() |
Σ | 0..1 | boolean | Whether this practitioner role record is in active use | ||||
![]() ![]() |
Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||
![]() ![]() |
SΣC | 1..1 | Reference(US Core Practitioner Profile(6.1.0)) | (USCDI+) Provider Address, (USCDI+) Provider Email, (USCDI+) Provider Fax, (USCDI+) Provider Name, (USCDI+) Provider NPI, (USCDI+) Provider Phone (contained in referenced US Core Practitioner) | ||||
![]() ![]() |
SΣC | 0..1 | Reference(US Public Health Organization(2.0.0)) | Organization where the roles are available | ||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: CareTeamMemberFunction (20240605) (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc. | ||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: HealthcareProviderTaxonomy (20240606) (extensible) | ||||
![]() ![]() |
SΣC | 0..* | Reference(US Public Health Location(2.0.0)) | The location(s) at which this practitioner provides care | ||||
![]() ![]() |
C | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | ||||
![]() ![]() |
SΣC | 1..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() |
0..* | BackboneElement | Times the Service Site is available | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
![]() ![]() ![]() |
0..1 | boolean | Always available? e.g. 24 hour service | |||||
![]() ![]() ![]() |
0..1 | time | Opening time of day (ignored if allDay = true) | |||||
![]() ![]() ![]() |
0..1 | time | Closing time of day (ignored if allDay = true) | |||||
![]() ![]() |
0..* | BackboneElement | Not available during this time due to provided reason | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
1..1 | string | Reason presented to the user explaining why time not available | |||||
![]() ![]() ![]() |
0..1 | Period | Service not available from this date | |||||
![]() ![]() |
0..1 | string | Description of availability exceptions | |||||
![]() ![]() |
SC | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| PractitionerRole.code | Base | extensible |
Care Team Member Function
|
📍20240605 | VSAC v0.23 |
| PractitionerRole.specialty | Base | extensible |
Healthcare Provider Taxonomy
|
📍20240606 | VSAC v0.23 |
| PractitionerRole.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| PractitionerRole.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| PractitionerRole.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| 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 | PractitionerRole.meta, PractitionerRole.implicitRules, PractitionerRole.language, PractitionerRole.text, PractitionerRole.extension, PractitionerRole.modifierExtension, PractitionerRole.identifier, PractitionerRole.active, PractitionerRole.period, PractitionerRole.practitioner, PractitionerRole.organization, PractitionerRole.code, PractitionerRole.specialty, PractitionerRole.location, PractitionerRole.healthcareService, PractitionerRole.telecom, PractitionerRole.telecom.extension, PractitionerRole.telecom.system, PractitionerRole.telecom.value, PractitionerRole.telecom.use, PractitionerRole.telecom.rank, PractitionerRole.telecom.period, PractitionerRole.availableTime, PractitionerRole.availableTime.extension, PractitionerRole.availableTime.modifierExtension, PractitionerRole.availableTime.daysOfWeek, PractitionerRole.availableTime.allDay, PractitionerRole.availableTime.availableStartTime, PractitionerRole.availableTime.availableEndTime, PractitionerRole.notAvailable, PractitionerRole.notAvailable.extension, PractitionerRole.notAvailable.modifierExtension, PractitionerRole.notAvailable.description, PractitionerRole.notAvailable.during, PractitionerRole.availabilityExceptions, PractitionerRole.endpoint | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | PractitionerRole.extension, PractitionerRole.modifierExtension, PractitionerRole.telecom.extension, PractitionerRole.availableTime.extension, PractitionerRole.availableTime.modifierExtension, PractitionerRole.notAvailable.extension, PractitionerRole.notAvailable.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| pd-1 | error | PractitionerRole | SHALL have contact information or a reference to an Endpoint |
telecom or endpoint
|
| us-core-13 | error | PractitionerRole | SHALL have a practitioner, an organization, a healthcare service, or a location. |
practitioner or organization or healthcareService or location
|
Summary
Mandatory: 2 elements
Structures
This structure refers to these other structures:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron