SDOH Clinical Care
3.0.0-ballot - STU 3 Ballot United States of America flag

SDOH Clinical Care - Downloaded Version 3.0.0-ballot See the Directory of published versions

Resource Profile: SDOHCC PractitionerRole

Official URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-practitionerrole Version: 3.0.0-ballot
Standards status: Trial-use Active as of 2025-12-13 Maturity Level: 2 Computable Name: SDOHCCPractitionerRole

Profile for practitioner roles that address Social Determinants of Health (SDOH).

Purpose

The SDOHCC PractitionerRole was created due to incompatibility across different versions of US Core. In US Core 3.1.1, PractitionerRole.code binds to a value set using NUCC codes. US Core 6.1.0 and US Core 7.0.0 binds to a value set using SNOMED codes. To be backward compatible, SDOHCC PractitionerRole binds to both NUCC and SNOMED based value sets. Below are mappings from NUCC to SNOMED and vice versa:

NUCC to SNOMED Mappings

SNOMED to NUCC Mappings

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole C 0..* USCorePractitionerRoleProfile(7.0.0) Roles/organizations the practitioner is associated with
Constraints: pd-1, us-core-13
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... practitioner SΣC 1..1 Reference(US Core Practitioner Profile(7.0.0)) Practitioner that is able to provide the defined services for the organization
... code SΣ 0..* CodeableConcept Roles which this practitioner may perform
Binding: CareTeamMemberFunction (20240605) . (extensible)
Additional BindingsPurpose
USCoreProviderRoleNucc (3.1.1) Extensible

... specialty SΣ 0..* CodeableConcept Specific specialty of the practitioner
Binding: HealthcareProviderTaxonomy (20240606) . (extensible)
... location SΣC 0..* Reference(US Core Location Profile(7.0.0)) The location(s) at which this practitioner provides care
... telecom SΣC 0..* ContactPoint Contact details that are specific to the role/location/service
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 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.
... endpoint SC 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PractitionerRole.code Base extensible Care Team Member Function . 📍20240605 VSAC v0.24
PractitionerRole.specialty Base extensible Healthcare Provider Taxonomy . 📍20240606 VSAC v0.24
PractitionerRole.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error PractitionerRole If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error PractitionerRole If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error PractitionerRole If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error PractitionerRole If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice PractitionerRole A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pd-1 error PractitionerRole SHALL have contact information or a reference to an Endpoint telecom.exists() or endpoint.exists()
us-core-13 error PractitionerRole SHALL have a practitioner, an organization, a healthcare service, or a location. practitioner.exists() or organization.exists() or healthcareService.exists() or location.exists()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* USCorePractitionerRoleProfile(7.0.0) Roles/organizations the practitioner is associated with
... practitioner 1..1 Reference(US Core Practitioner Profile(7.0.0)) Practitioner that is able to provide the defined services for the organization
... organization 1..1 Reference(US Core Organization Profile(7.0.0)) Organization where the roles are available
... code 0..* CodeableConcept Roles which this practitioner may perform
Binding: CareTeamMemberFunction (20240605) . (extensible)
Additional BindingsPurpose
USCoreProviderRoleNucc (3.1.1) Extensible

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
PractitionerRole.code Base extensible Care Team Member Function . 📍20240605 VSAC v0.24
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole C 0..* USCorePractitionerRoleProfile(7.0.0) Roles/organizations the practitioner is associated with
Constraints: pd-1, us-core-13
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifiers that are specific to a role/location
... active Σ 0..1 boolean Whether this practitioner role record is in active use
... period Σ 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣC 1..1 Reference(US Core Practitioner Profile(7.0.0)) Practitioner that is able to provide the defined services for the organization
... organization SΣC 1..1 Reference(US Core Organization Profile(7.0.0)) Organization where the roles are available
... code SΣ 0..* CodeableConcept Roles which this practitioner may perform
Binding: CareTeamMemberFunction (20240605) . (extensible)
Additional BindingsPurpose
USCoreProviderRoleNucc (3.1.1) Extensible

... specialty SΣ 0..* CodeableConcept Specific specialty of the practitioner
Binding: HealthcareProviderTaxonomy (20240606) . (extensible)
... location SΣC 0..* Reference(US Core Location Profile(7.0.0)) The location(s) at which this practitioner provides care
... healthcareService C 0..* Reference(HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SΣC 0..* ContactPoint Contact details that are specific to the role/location/service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 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 SC 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

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.24
PractitionerRole.specialty Base extensible Healthcare Provider Taxonomy . 📍20240606 VSAC v0.24
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.

Constraints

Id Grade Path(s) Description Expression
dom-2 error PractitionerRole If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error PractitionerRole If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error PractitionerRole If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error PractitionerRole If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice PractitionerRole A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pd-1 error PractitionerRole SHALL have contact information or a reference to an Endpoint telecom.exists() or endpoint.exists()
us-core-13 error PractitionerRole SHALL have a practitioner, an organization, a healthcare service, or a location. practitioner.exists() or organization.exists() or healthcareService.exists() or location.exists()

Summary

Mandatory: 2 elements

Structures

This structure refers to these other structures:

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole C 0..* USCorePractitionerRoleProfile(7.0.0) Roles/organizations the practitioner is associated with
Constraints: pd-1, us-core-13
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... practitioner SΣC 1..1 Reference(US Core Practitioner Profile(7.0.0)) Practitioner that is able to provide the defined services for the organization
... code SΣ 0..* CodeableConcept Roles which this practitioner may perform
Binding: CareTeamMemberFunction (20240605) . (extensible)
Additional BindingsPurpose
USCoreProviderRoleNucc (3.1.1) Extensible

... specialty SΣ 0..* CodeableConcept Specific specialty of the practitioner
Binding: HealthcareProviderTaxonomy (20240606) . (extensible)
... location SΣC 0..* Reference(US Core Location Profile(7.0.0)) The location(s) at which this practitioner provides care
... telecom SΣC 0..* ContactPoint Contact details that are specific to the role/location/service
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 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.
... endpoint SC 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PractitionerRole.code Base extensible Care Team Member Function . 📍20240605 VSAC v0.24
PractitionerRole.specialty Base extensible Healthcare Provider Taxonomy . 📍20240606 VSAC v0.24
PractitionerRole.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error PractitionerRole If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error PractitionerRole If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error PractitionerRole If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error PractitionerRole If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice PractitionerRole A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pd-1 error PractitionerRole SHALL have contact information or a reference to an Endpoint telecom.exists() or endpoint.exists()
us-core-13 error PractitionerRole SHALL have a practitioner, an organization, a healthcare service, or a location. practitioner.exists() or organization.exists() or healthcareService.exists() or location.exists()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* USCorePractitionerRoleProfile(7.0.0) Roles/organizations the practitioner is associated with
... practitioner 1..1 Reference(US Core Practitioner Profile(7.0.0)) Practitioner that is able to provide the defined services for the organization
... organization 1..1 Reference(US Core Organization Profile(7.0.0)) Organization where the roles are available
... code 0..* CodeableConcept Roles which this practitioner may perform
Binding: CareTeamMemberFunction (20240605) . (extensible)
Additional BindingsPurpose
USCoreProviderRoleNucc (3.1.1) Extensible

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
PractitionerRole.code Base extensible Care Team Member Function . 📍20240605 VSAC v0.24

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole C 0..* USCorePractitionerRoleProfile(7.0.0) Roles/organizations the practitioner is associated with
Constraints: pd-1, us-core-13
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifiers that are specific to a role/location
... active Σ 0..1 boolean Whether this practitioner role record is in active use
... period Σ 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣC 1..1 Reference(US Core Practitioner Profile(7.0.0)) Practitioner that is able to provide the defined services for the organization
... organization SΣC 1..1 Reference(US Core Organization Profile(7.0.0)) Organization where the roles are available
... code SΣ 0..* CodeableConcept Roles which this practitioner may perform
Binding: CareTeamMemberFunction (20240605) . (extensible)
Additional BindingsPurpose
USCoreProviderRoleNucc (3.1.1) Extensible

... specialty SΣ 0..* CodeableConcept Specific specialty of the practitioner
Binding: HealthcareProviderTaxonomy (20240606) . (extensible)
... location SΣC 0..* Reference(US Core Location Profile(7.0.0)) The location(s) at which this practitioner provides care
... healthcareService C 0..* Reference(HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SΣC 0..* ContactPoint Contact details that are specific to the role/location/service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 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 SC 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

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.24
PractitionerRole.specialty Base extensible Healthcare Provider Taxonomy . 📍20240606 VSAC v0.24
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.

Constraints

Id Grade Path(s) Description Expression
dom-2 error PractitionerRole If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error PractitionerRole If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error PractitionerRole If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error PractitionerRole If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice PractitionerRole A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pd-1 error PractitionerRole SHALL have contact information or a reference to an Endpoint telecom.exists() or endpoint.exists()
us-core-13 error PractitionerRole SHALL have a practitioner, an organization, a healthcare service, or a location. practitioner.exists() or organization.exists() or healthcareService.exists() or location.exists()

Summary

Mandatory: 2 elements

Structures

This structure refers to these other structures:

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron