National Healthcare Directory Query
1.0.0-ballot - ballot US

This page is part of the National Healthcare Query (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: National Directory Endpoint Qry Exchange PractitionerRole

Official URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-PractitionerRole Version: 1.0.0-ballot
Active as of 2022-08-09 Computable Name: NatlDirEndpointQryPractitionerRole

PractionerRole describes details about a provider, which can be a practitioner or an organization. When the provider is a practitioner, there may be a relationship to an organization. A provider renders services to patients at a location. When the provider is a practitioner, there may also be a relationship to an organization. Practitioner participation in healthcare provider insurance networks may be direct or through their role at an organization.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from PractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*PractitionerRoleRoles/organizations the practitioner is associated with
practitioner-or-organization-or-healthcareservice-or-location: If NatlDirPractitionerRole.practitioner is absent ( NatlDirPractitionerRole.organization, NatlDirPractitionerRole.healthcareservice, NatlDirPractitionerRole.location) must be present
... meta
.... lastUpdated 1..1instantWhen the resource version last changed
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... rating 0..*(Complex)Rating
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/rating
... network-reference 0..1Reference(National Directory Endpoint Qry Exchange Network)NetworkReference
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/network-reference
... identifier S0..*IdentifierBusiness Identifiers that are specific to a role/location
... active 1..1booleanWhether this practitioner role record is in active use
... practitioner S1..1Reference(National Directory Endpoint Qry Exchange Practitioner)Practitioner that is able to provide the defined services for the organization
... organization S1..1Reference(National Directory Endpoint Qry Exchange Organization)Organization where the roles are available
... code S0..*CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole Code Value Set (required)
... specialty S0..*CodeableConceptSpecific specialty of the practitioner
Binding: Individual and Group Specialties (required)
... location S0..*Reference(National Directory Endpoint Qry Exchange Location)The location(s) at which this practitioner provides care
... healthcareService S0..*Reference(National Directory Endpoint Qry Exchange HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom
.... contactpoint-availabletime 0..*(Complex)Contactpoint Availabletime
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
.... via-intermediary 0..*Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization)Via Intermediary
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
.... system 1..1codephone | fax | email | pager | url | sms | other
.... value 1..1stringThe actual contact point details
... endpoint S0..*Reference(National Directory Endpoint Qry Exchange 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
practitioner-or-organization-or-healthcareservice-or-location: If NatlDirPractitionerRole.practitioner is absent ( NatlDirPractitionerRole.organization, NatlDirPractitionerRole.healthcareservice, NatlDirPractitionerRole.location) must be present
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... rating 0..*(Complex)Rating
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/rating
... newpatients I0..*(Complex)New Patients
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/newpatients
... network-reference 0..1Reference(National Directory Endpoint Qry Exchange Network)NetworkReference
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/network-reference
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness Identifiers that are specific to a role/location
... active Σ1..1booleanWhether this practitioner role record is in active use
... period Σ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣ1..1Reference(National Directory Endpoint Qry Exchange Practitioner)Practitioner that is able to provide the defined services for the organization
... organization SΣ1..1Reference(National Directory Endpoint Qry Exchange Organization)Organization where the roles are available
... code SΣ0..*CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole Code Value Set (required)
... specialty SΣ0..*CodeableConceptSpecific specialty of the practitioner
Binding: Individual and Group Specialties (required)
... location SΣ0..*Reference(National Directory Endpoint Qry Exchange Location)The location(s) at which this practitioner provides care
... healthcareService S0..*Reference(National Directory Endpoint Qry Exchange HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom Σ0..*ContactPointContact details that are specific to the role/location/service
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime 0..*(Complex)Contactpoint Availabletime
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
.... via-intermediary 0..*Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization)Via Intermediary
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
.... system ΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ1..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint S0..*Reference(National Directory Endpoint Qry Exchange 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
practitioner-or-organization-or-healthcareservice-or-location: If NatlDirPractitionerRole.practitioner is absent ( NatlDirPractitionerRole.organization, NatlDirPractitionerRole.healthcareservice, NatlDirPractitionerRole.location) must be present
... identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
... practitioner Σ1..1Reference(National Directory Endpoint Qry Exchange Practitioner)Practitioner that is able to provide the defined services for the organization
... organization Σ1..1Reference(National Directory Endpoint Qry Exchange Organization)Organization where the roles are available
... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: Individual and Group Specialties (required)
... location Σ0..*Reference(National Directory Endpoint Qry Exchange Location)The location(s) at which this practitioner provides care
... healthcareService 0..*Reference(National Directory Endpoint Qry Exchange HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... endpoint 0..*Reference(National Directory Endpoint Qry Exchange Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Differential View

This structure is derived from PractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*PractitionerRoleRoles/organizations the practitioner is associated with
practitioner-or-organization-or-healthcareservice-or-location: If NatlDirPractitionerRole.practitioner is absent ( NatlDirPractitionerRole.organization, NatlDirPractitionerRole.healthcareservice, NatlDirPractitionerRole.location) must be present
... meta
.... lastUpdated 1..1instantWhen the resource version last changed
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... rating 0..*(Complex)Rating
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/rating
... network-reference 0..1Reference(National Directory Endpoint Qry Exchange Network)NetworkReference
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/network-reference
... identifier S0..*IdentifierBusiness Identifiers that are specific to a role/location
... active 1..1booleanWhether this practitioner role record is in active use
... practitioner S1..1Reference(National Directory Endpoint Qry Exchange Practitioner)Practitioner that is able to provide the defined services for the organization
... organization S1..1Reference(National Directory Endpoint Qry Exchange Organization)Organization where the roles are available
... code S0..*CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole Code Value Set (required)
... specialty S0..*CodeableConceptSpecific specialty of the practitioner
Binding: Individual and Group Specialties (required)
... location S0..*Reference(National Directory Endpoint Qry Exchange Location)The location(s) at which this practitioner provides care
... healthcareService S0..*Reference(National Directory Endpoint Qry Exchange HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom
.... contactpoint-availabletime 0..*(Complex)Contactpoint Availabletime
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
.... via-intermediary 0..*Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization)Via Intermediary
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
.... system 1..1codephone | fax | email | pager | url | sms | other
.... value 1..1stringThe actual contact point details
... endpoint S0..*Reference(National Directory Endpoint Qry Exchange 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
practitioner-or-organization-or-healthcareservice-or-location: If NatlDirPractitionerRole.practitioner is absent ( NatlDirPractitionerRole.organization, NatlDirPractitionerRole.healthcareservice, NatlDirPractitionerRole.location) must be present
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... rating 0..*(Complex)Rating
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/rating
... newpatients I0..*(Complex)New Patients
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/newpatients
... network-reference 0..1Reference(National Directory Endpoint Qry Exchange Network)NetworkReference
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/network-reference
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness Identifiers that are specific to a role/location
... active Σ1..1booleanWhether this practitioner role record is in active use
... period Σ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣ1..1Reference(National Directory Endpoint Qry Exchange Practitioner)Practitioner that is able to provide the defined services for the organization
... organization SΣ1..1Reference(National Directory Endpoint Qry Exchange Organization)Organization where the roles are available
... code SΣ0..*CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole Code Value Set (required)
... specialty SΣ0..*CodeableConceptSpecific specialty of the practitioner
Binding: Individual and Group Specialties (required)
... location SΣ0..*Reference(National Directory Endpoint Qry Exchange Location)The location(s) at which this practitioner provides care
... healthcareService S0..*Reference(National Directory Endpoint Qry Exchange HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom Σ0..*ContactPointContact details that are specific to the role/location/service
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime 0..*(Complex)Contactpoint Availabletime
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
.... via-intermediary 0..*Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization)Via Intermediary
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
.... system ΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ1..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint S0..*Reference(National Directory Endpoint Qry Exchange Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
PractitionerRole.meta.securityextensibleAll Security Labels
PractitionerRole.meta.tagexampleCommonTags
PractitionerRole.languagepreferredCommonLanguages
Max Binding: AllLanguages
PractitionerRole.coderequiredPractitionerRoleVS
PractitionerRole.specialtyrequiredIndividualAndGroupSpecialtiesVS
PractitionerRole.telecom.systemrequiredContactPointSystem
PractitionerRole.telecom.userequiredContactPointUse
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePathDetailsRequirements
practitioner-or-organization-or-healthcareservice-or-locationerrorPractitionerRoleIf NatlDirPractitionerRole.practitioner is absent ( NatlDirPractitionerRole.organization, NatlDirPractitionerRole.healthcareservice, NatlDirPractitionerRole.location) must be present
: practitioner.exists() or (organization.exists() or healthcareservice.exists() or location.exists())