DaVinci PDEX Plan Net STU Ballot

This page is part of the DaVinci PDEX Plan Net (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

PractitionerRole

 

The official URL for this profile is: 

http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-PractitionerRole

PractitionerRole describes the role a practitioner plays at an organization, including the services they provide, the location(s) where they work, and their availability, electronic endpoints, and other relevant information.

This profile builds on USCorePractitionerRoleProfile.

This profile was published on Wed Oct 23 00:00:00 EDT 2019 as a active by HL7 Financial Management WG.

Summary

Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 23 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

plannet.PractitionerRole maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole:
  NewPatients maps to extension
  NewPatientProfile maps to http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile
  TAvailableTime maps to telecom.extension http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
  TViaIntermediary maps to telecom.extension
  PN_Identifier.IdentifierUse maps to identifier.use
  PN_Identifier.IdentifierSystem maps to identifier.system
  PN_Identifier.IdentifierValue maps to identifier.value
  PN_Identifier.IdentifierType maps to identifier.type
  PN_Identifier.IdentifierPeriod maps to identifier.period
  PN_Identifier.IdentifierAssigner maps to identifier.assigner
  PractitionerRoleQualification maps to http://hl7.org/fhir/uv/vhdir/StructureDefinition/practitioner-qualification
  PractitionerRoleActive maps to active
  PractitionerRoleSpecialty maps to specialty
  PractitionerRoleCode maps to code
  PractitionerRolePeriod maps to period
  PractitionerRoleLocation maps to location
  NAvailableTime maps to availableTime
  NAvailableTime.AllDay maps to availableTime.allDay
  NAvailableTime.DaysOfWeek maps to availableTime.daysOfWeek
  NAvailableTime.AvailableStartTime maps to availableTime.availableStartTime
  NAvailableTime.AvailableEndTime maps to availableTime.availableEndTime
  NotAvailable maps to notAvailable
  NotAvailable.Description maps to notAvailable.description
  NotAvailable.DuringPeriod maps to notAvailable.during
  PractitionerRoleTelecom maps to telecom
  PractitionerRoleTelecom.ContactPoint.Purpose maps to telecom.use
  PractitionerRoleTelecom.ContactPoint.Type maps to telecom.system
  PractitionerRoleTelecom.ContactPoint.PriorityRank maps to telecom.rank
  PractitionerRoleTelecom.ContactPoint.EffectiveTimePeriod maps to telecom.period
  PractitionerRoleTelecom.ContactPoint.TelecomNumberOrAddress maps to telecom.value
  Organization maps to organization
  ParticipatingNetwork maps to extension
  Practitioner maps to practitioner
  PractitionerRoleHealthcareService maps to healthcareService
  constrain active to 1..1
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole plannet-PractitionerRole
... extension Slice: Unordered, Open by value:url
... plannet-NewPatients-extension S0..*(Complex)NewPatients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-NewPatients-extension
... plannet-ParticipatingNetwork-extension S0..*Reference(plannet-Network)ParticipatingNetwork
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-ParticipatingNetwork-extension
... newpatientprofile S0..*string​New patient profile
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile
... practitioner-qualification S0..*(Complex)​Adds status, whereValid, history elements
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/practitioner-qualification
... identifier
.... use S
.... type S
.... system S
.... value S
.... period S
.... assigner SReference(plannet-Organization)
... active S1..1
... period S
... practitioner Reference(plannet-Practitioner)
... organization Reference(plannet-Organization)
... code 1..1
... location Reference(plannet-Location)
... healthcareService SReference(plannet-HealthcareService)
... telecom
.... contactpoint-availabletime S0..*(Complex)​Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... plannet-CViaIntermediary-extension S0..*Reference(plannet-PractitionerRole | plannet-Organization | plannet-OrganizationAffiliation | plannet-Location)CViaIntermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-CViaIntermediary-extension
... availableTime S
.... daysOfWeek S
.... allDay S
.... availableStartTime S
.... availableEndTime S
... notAvailable S
.... description S
.... during S

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*plannet-PractitionerRole
pd-1: SHALL have contact information or a reference to an Endpoint
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... plannet-NewPatients-extension S0..*(Complex)NewPatients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-NewPatients-extension
... plannet-ParticipatingNetwork-extension S0..*Reference(plannet-Network)ParticipatingNetwork
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-ParticipatingNetwork-extension
... newpatientprofile S0..*string​New patient profile
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile
... practitioner-qualification S0..*(Complex)​Adds status, whereValid, history elements
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/practitioner-qualification
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... period SΣ0..1PeriodTime period when id is/was valid for use
.... assigner SΣ0..1Reference(plannet-Organization)Organization that issued id (may be just text)
... active SΣ1..1booleanWhether this practitioner role record is in active use
... period SΣ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣ1..1Reference(plannet-Practitioner)Practitioner that is able to provide the defined services for the organization
... organization SΣ1..1Reference(plannet-Organization)Organization where the roles are available
... code SΣ1..1CodeableConceptRoles which this practitioner may perform
Binding: US Core Provider Role (NUCC) (extensible)
... specialty SΣ0..1CodeableConceptSpecific specialty of the practitioner
Binding: US Core Provider Speciality (NUCC) (extensible)
... location SΣ0..*Reference(plannet-Location)The location(s) at which this practitioner provides care
... healthcareService S0..*Reference(plannet-HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SΣ0..*ContactPointContact details that are specific to the role/location/service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime S0..*(Complex)​Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... plannet-CViaIntermediary-extension S0..*Reference(plannet-PractitionerRole | plannet-Organization | plannet-OrganizationAffiliation | plannet-Location)CViaIntermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-CViaIntermediary-extension
.... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣ1..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... availableTime SI0..*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 S0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay S0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime S0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime S0..1timeClosing time of day (ignored if allDay = true)
... notAvailable SI0..*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 S1..1stringReason presented to the user explaining why time not available
.... during S0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint S0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Summary

Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 23 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

plannet.PractitionerRole maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole:
  NewPatients maps to extension
  NewPatientProfile maps to http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile
  TAvailableTime maps to telecom.extension http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
  TViaIntermediary maps to telecom.extension
  PN_Identifier.IdentifierUse maps to identifier.use
  PN_Identifier.IdentifierSystem maps to identifier.system
  PN_Identifier.IdentifierValue maps to identifier.value
  PN_Identifier.IdentifierType maps to identifier.type
  PN_Identifier.IdentifierPeriod maps to identifier.period
  PN_Identifier.IdentifierAssigner maps to identifier.assigner
  PractitionerRoleQualification maps to http://hl7.org/fhir/uv/vhdir/StructureDefinition/practitioner-qualification
  PractitionerRoleActive maps to active
  PractitionerRoleSpecialty maps to specialty
  PractitionerRoleCode maps to code
  PractitionerRolePeriod maps to period
  PractitionerRoleLocation maps to location
  NAvailableTime maps to availableTime
  NAvailableTime.AllDay maps to availableTime.allDay
  NAvailableTime.DaysOfWeek maps to availableTime.daysOfWeek
  NAvailableTime.AvailableStartTime maps to availableTime.availableStartTime
  NAvailableTime.AvailableEndTime maps to availableTime.availableEndTime
  NotAvailable maps to notAvailable
  NotAvailable.Description maps to notAvailable.description
  NotAvailable.DuringPeriod maps to notAvailable.during
  PractitionerRoleTelecom maps to telecom
  PractitionerRoleTelecom.ContactPoint.Purpose maps to telecom.use
  PractitionerRoleTelecom.ContactPoint.Type maps to telecom.system
  PractitionerRoleTelecom.ContactPoint.PriorityRank maps to telecom.rank
  PractitionerRoleTelecom.ContactPoint.EffectiveTimePeriod maps to telecom.period
  PractitionerRoleTelecom.ContactPoint.TelecomNumberOrAddress maps to telecom.value
  Organization maps to organization
  ParticipatingNetwork maps to extension
  Practitioner maps to practitioner
  PractitionerRoleHealthcareService maps to healthcareService
  constrain active to 1..1

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole plannet-PractitionerRole
... extension Slice: Unordered, Open by value:url
... plannet-NewPatients-extension S0..*(Complex)NewPatients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-NewPatients-extension
... plannet-ParticipatingNetwork-extension S0..*Reference(plannet-Network)ParticipatingNetwork
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-ParticipatingNetwork-extension
... newpatientprofile S0..*string​New patient profile
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile
... practitioner-qualification S0..*(Complex)​Adds status, whereValid, history elements
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/practitioner-qualification
... identifier
.... use S
.... type S
.... system S
.... value S
.... period S
.... assigner SReference(plannet-Organization)
... active S1..1
... period S
... practitioner Reference(plannet-Practitioner)
... organization Reference(plannet-Organization)
... code 1..1
... location Reference(plannet-Location)
... healthcareService SReference(plannet-HealthcareService)
... telecom
.... contactpoint-availabletime S0..*(Complex)​Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... plannet-CViaIntermediary-extension S0..*Reference(plannet-PractitionerRole | plannet-Organization | plannet-OrganizationAffiliation | plannet-Location)CViaIntermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-CViaIntermediary-extension
... availableTime S
.... daysOfWeek S
.... allDay S
.... availableStartTime S
.... availableEndTime S
... notAvailable S
.... description S
.... during S

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*plannet-PractitionerRole
pd-1: SHALL have contact information or a reference to an Endpoint
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... plannet-NewPatients-extension S0..*(Complex)NewPatients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-NewPatients-extension
... plannet-ParticipatingNetwork-extension S0..*Reference(plannet-Network)ParticipatingNetwork
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-ParticipatingNetwork-extension
... newpatientprofile S0..*string​New patient profile
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile
... practitioner-qualification S0..*(Complex)​Adds status, whereValid, history elements
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/practitioner-qualification
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... period SΣ0..1PeriodTime period when id is/was valid for use
.... assigner SΣ0..1Reference(plannet-Organization)Organization that issued id (may be just text)
... active SΣ1..1booleanWhether this practitioner role record is in active use
... period SΣ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣ1..1Reference(plannet-Practitioner)Practitioner that is able to provide the defined services for the organization
... organization SΣ1..1Reference(plannet-Organization)Organization where the roles are available
... code SΣ1..1CodeableConceptRoles which this practitioner may perform
Binding: US Core Provider Role (NUCC) (extensible)
... specialty SΣ0..1CodeableConceptSpecific specialty of the practitioner
Binding: US Core Provider Speciality (NUCC) (extensible)
... location SΣ0..*Reference(plannet-Location)The location(s) at which this practitioner provides care
... healthcareService S0..*Reference(plannet-HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SΣ0..*ContactPointContact details that are specific to the role/location/service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime S0..*(Complex)​Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... plannet-CViaIntermediary-extension S0..*Reference(plannet-PractitionerRole | plannet-Organization | plannet-OrganizationAffiliation | plannet-Location)CViaIntermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-CViaIntermediary-extension
.... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣ1..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... availableTime SI0..*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 S0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay S0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime S0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime S0..1timeClosing time of day (ignored if allDay = true)
... notAvailable SI0..*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 S1..1stringReason presented to the user explaining why time not available
.... during S0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint S0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

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

 

Terminology Bindings

PathConformanceValueSet
PractitionerRole.languagepreferredCommonLanguages
Max Binding: AllLanguages
PractitionerRole.identifier.userequiredIdentifierUse
PractitionerRole.identifier.typeextensibleIdentifier Type Codes
PractitionerRole.codeextensibleUSCoreProviderRoleNucc
PractitionerRole.specialtyextensibleUSCoreProviderSpecialityNucc
PractitionerRole.telecom.systemrequiredContactPointSystem
PractitionerRole.telecom.userequiredContactPointUse
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek

 

Constraints

IdPathDetailsRequirements
dom-2PractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4PractitionerRoleIf 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-3PractitionerRoleIf 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-6PractitionerRoleA resource should have narrative for robust management
: text.div.exists()
dom-5PractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
pd-1PractitionerRoleSHALL have contact information or a reference to an Endpoint
: telecom or endpoint
ele-1PractitionerRole.availableTimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.notAvailableAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())