HL7 FHIR® US Core Implementation Guide STU3 Release 3.1.1

This page is part of the US Core (v3.1.1: STU3) based on FHIR R4. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions

StructureDefinition-us-core-practitionerrole

Scope and Usage

This profile sets minimum expectations for the PractitionerRole resource to record, search, and fetch the practitioner role for a practitioner. It identifies the mandatory core elements, extensions, vocabularies and value sets which SHALL be present in the PractitionerRole resource when using this profile. The requirements for the US Core Practitioner were drawn from the Argonaut Provider Directory, IHE Healthcare Provider Directory and the ONC Provider Directory Workshop.

Mandatory and Must Support Data Elements

The following data-elements are mandatory (i.e data MUST be present) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each PractitionerRole must have:

  1. An associated practitioner
  2. An associated organization

Each PractitionerRole must support:

  1. A role
  2. A specialty
  3. An associated location
  4. Contact information
  5. A communication endpoint

Profile specific implementation guidance:

  • The PractitionerRole.endpoint is where a Direct address may be represented.
  • Clients can request servers return the Practitioner resource and Endpoint resources by using _include. See Quick Start.
  • As a result of implementation feedback, the US Core Location and PractitionerRole Profiles are not explicitly referenced in any US Core Profile. However they SHOULD be used as the default profile if referenced by another US Core profile. See this guidance on Referencing US Core Profiles.

Examples

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole

Published on Sun Aug 11 00:00:00 AEST 2019 as active by the HL7 US Realm Steering Committee.

This profile builds on PractitionerRole

PractitionerRole

Summary of the Mandatory Requirements

  1. A Practitioner Reference in PractitionerRole.practitioner
  2. A Organization Reference in PractitionerRole.organization

Summary of the Must Support Requirements

  1. One or more CodeableConcepts in PractitionerRole.code with an extensible binding to US Core Provider Role (NUCC)
  2. One or more CodeableConcepts in PractitionerRole.specialty with an extensible binding to US Core Provider Speciality (NUCC)
  3. One or more Location References in PractitionerRole.location
  4. One or more ContactPoints in PractitionerRole.telecom
    • which must have a code value in PractitionerRole.telecom.system with a required binding to ContactPointSystem
    • which must have a string value in PractitionerRole.telecom.value
  5. One or more Endpoint References in PractitionerRole.endpoint

Summary of Constraints

  1. SHALL have contact information or a reference to an Endpoint
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*PractitionerRoleRoles/organizations the practitioner is associated with
pd-1: SHALL have contact information or a reference to an Endpoint
... practitioner S1..1Reference(US Core Practitioner Profile)Practitioner that is able to provide the defined services for the organization
... organization S1..1Reference(US Core Organization Profile)Organization where the roles are available
... code S0..*CodeableConceptRoles which this practitioner may perform
Binding: US Core Provider Role (NUCC) (extensible)
... specialty S0..*CodeableConceptSpecific specialty of the practitioner
Binding: US Core Provider Speciality (NUCC) (extensible)
... location S0..*Reference(Location)The location(s) at which this practitioner provides care
... telecom SI0..*ContactPointContact details that are specific to the role/location/service
.... system S1..1codephone | fax | email | pager | url | sms | other
.... value S1..1stringThe actual contact point details
... endpoint SI0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*PractitionerRoleRoles/organizations the practitioner is associated with
pd-1: SHALL have contact information or a reference to an Endpoint
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierBusiness Identifiers that are specific to a role/location
... active ΣI0..1booleanWhether this practitioner role record is in active use
... period ΣI0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣI1..1Reference(US Core Practitioner Profile)Practitioner that is able to provide the defined services for the organization
... organization SΣI1..1Reference(US Core Organization Profile)Organization where the roles are available
... code SΣI0..*CodeableConceptRoles which this practitioner may perform
Binding: US Core Provider Role (NUCC) (extensible)
... specialty SΣI0..*CodeableConceptSpecific specialty of the practitioner
Binding: US Core Provider Speciality (NUCC) (extensible)
... location SΣI0..*Reference(Location)The location(s) at which this practitioner provides care
... healthcareService I0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SΣI0..*ContactPointContact details that are specific to the role/location/service
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣI1..1stringThe actual contact point details
.... use ?!ΣI0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank ΣI0..1positiveIntSpecify preferred order of use (1 = highest)
.... period ΣI0..1PeriodTime period when the contact point was/is in use
... availableTime I0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek I0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay I0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime I0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime I0..1timeClosing time of day (ignored if allDay = true)
... notAvailable I0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description I1..1stringReason presented to the user explaining why time not available
.... during I0..1PeriodService not available from this date
... availabilityExceptions I0..1stringDescription of availability exceptions
... endpoint SI0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

PractitionerRole

Summary of the Mandatory Requirements

  1. A Practitioner Reference in PractitionerRole.practitioner
  2. A Organization Reference in PractitionerRole.organization

Summary of the Must Support Requirements

  1. One or more CodeableConcepts in PractitionerRole.code with an extensible binding to US Core Provider Role (NUCC)
  2. One or more CodeableConcepts in PractitionerRole.specialty with an extensible binding to US Core Provider Speciality (NUCC)
  3. One or more Location References in PractitionerRole.location
  4. One or more ContactPoints in PractitionerRole.telecom
    • which must have a code value in PractitionerRole.telecom.system with a required binding to ContactPointSystem
    • which must have a string value in PractitionerRole.telecom.value
  5. One or more Endpoint References in PractitionerRole.endpoint

Summary of Constraints

  1. SHALL have contact information or a reference to an Endpoint

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*PractitionerRoleRoles/organizations the practitioner is associated with
pd-1: SHALL have contact information or a reference to an Endpoint
... practitioner S1..1Reference(US Core Practitioner Profile)Practitioner that is able to provide the defined services for the organization
... organization S1..1Reference(US Core Organization Profile)Organization where the roles are available
... code S0..*CodeableConceptRoles which this practitioner may perform
Binding: US Core Provider Role (NUCC) (extensible)
... specialty S0..*CodeableConceptSpecific specialty of the practitioner
Binding: US Core Provider Speciality (NUCC) (extensible)
... location S0..*Reference(Location)The location(s) at which this practitioner provides care
... telecom SI0..*ContactPointContact details that are specific to the role/location/service
.... system S1..1codephone | fax | email | pager | url | sms | other
.... value S1..1stringThe actual contact point details
... endpoint SI0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*PractitionerRoleRoles/organizations the practitioner is associated with
pd-1: SHALL have contact information or a reference to an Endpoint
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierBusiness Identifiers that are specific to a role/location
... active ΣI0..1booleanWhether this practitioner role record is in active use
... period ΣI0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣI1..1Reference(US Core Practitioner Profile)Practitioner that is able to provide the defined services for the organization
... organization SΣI1..1Reference(US Core Organization Profile)Organization where the roles are available
... code SΣI0..*CodeableConceptRoles which this practitioner may perform
Binding: US Core Provider Role (NUCC) (extensible)
... specialty SΣI0..*CodeableConceptSpecific specialty of the practitioner
Binding: US Core Provider Speciality (NUCC) (extensible)
... location SΣI0..*Reference(Location)The location(s) at which this practitioner provides care
... healthcareService I0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SΣI0..*ContactPointContact details that are specific to the role/location/service
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣI1..1stringThe actual contact point details
.... use ?!ΣI0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank ΣI0..1positiveIntSpecify preferred order of use (1 = highest)
.... period ΣI0..1PeriodTime period when the contact point was/is in use
... availableTime I0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek I0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay I0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime I0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime I0..1timeClosing time of day (ignored if allDay = true)
... notAvailable I0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description I1..1stringReason presented to the user explaining why time not available
.... during I0..1PeriodService not available from this date
... availabilityExceptions I0..1stringDescription of availability exceptions
... endpoint SI0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron


Quick Start

Below is an overview of the required set of Server RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.

  • The syntax used to describe the interactions is described here.
  • See the General Guidance section for additional rules and expectations when a server requires status parameters.
  • See the General Guidance section for additional guidance on searching for multiple patients.

Mandatory Search Parameters:

The following search parameters, search parameter combinations SHALL be supported.:

  1. SHALL support searching practitioner role by specialty using the specialty search parameter:

    • including optional support for these _include parameters: PractitionerRole:endpoint,PractitionerRole:practitioner

    GET [base]/PractitionerRole?specialty={[system]}|[code]{&_include=PractitionerRole:practitioner}{&_include=PractitionerRole?endpoint}

    Example:

    1. GET [base]/PractitionerRole?specialty=http://nucc.org/provider-taxonomy|208D0000X&_include=PractitionerRole:practitioner&_include=PractitionerRole?endpoint

    Implementation Notes: Fetches a bundle containing PractitionerRole resources matching the specialty (how to search by token). SHOULD support the _include for PractionerRole.practitioner and PractitionerRole.endpoint. (how to search by reference)

  2. SHALL support searching practitioner role by practitioner name and identifier using chained parameters using the practitioner search parameter:

    • including support for these chained parameters: practitioner.identifier,practitioner.name
    • including optional support for these _include parameters: PractitionerRole:endpoint,PractitionerRole:practitioner

    GET [base]/PractitionerRole?practitioner=[reference]{&_include=PractitionerRole:practitioner}{&_include=PractitionerRole?endpoint}

    Example:

    1. GET [base]/PractitionerRole?practitioner.identifier=http://hl7.org/fhir/sid/us-npi|97860456&_include=PractitionerRole:practitioner&_include=PractitionerRole?endpoint
    2. GET [base]/PractitionerRole?practitioner.name=Henry&_include=PractitionerRole:practitioner&_include=PractitionerRole?endpoint

    Implementation Notes: Fetches a bundle containing PractitionerRole resources matching the chained parameter practitioner.name or practitioner.identifier. SHOULD support the _include for PractionerRole.practitioner and PractitionerRole.endpoint. (how to search by reference)