Patient Cost Transparency Implementation Guide
0.1.0 - STU 1 Ballot

This page is part of the Da Vinci Patient Cost Transparency Implementation Guide (v0.1.0: STU 1 Draft) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: PCT PractitionerRole

Defining URL:http://hl7.org/fhir/us/davinci-pct/StructureDefinition/davinci-pct-practitionerrole
Version:0.1.0
Name:PCTPractitionerRole
Title:PCT PractitionerRole
Status:Active as of 12/4/21 9:54 PM
Definition:

The PCT PractitionerRole profile builds upon the US Core PractitionerRole profile. It is used to convey information about the practitioner who will be providing services to the patient as described on the GFE.

Publisher:HL7 International - Financial Management Work Group
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://hl7.org/fhir/us/davinci-pct/StructureDefinition/davinci-pct-practitionerrole

Formal Views of Profile Content

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

This structure is derived from HRexPractitionerRole

Summary

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

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element PractitionerRole.identifier is sliced based on the value of pattern:type

This structure is derived from HRexPractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*HRexPractitionerRoleRoles/organizations the practitioner is associated with
... Slices for identifier 0..*IdentifierBusiness Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
.... identifier:NPI S0..1IdentifierThe National Provider Identifier assigned to the provider.
..... type 1..1CodeableConceptDescription of identifier
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
....... display1..1stringRepresentation defined by the system
Fixed Value: National provider identifier
..... system 0..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
..... value S1..1stringThe value that is unique
... organization 1..1Reference(PCT Organization)Organization where the roles are available

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*HRexPractitionerRoleRoles/organizations the practitioner is associated with
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... 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
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
.... identifier:NPI SΣ0..1IdentifierThe National Provider Identifier assigned to the provider.
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
....... display1..1stringRepresentation defined by the system
Fixed Value: National provider identifier
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active Σ0..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(HRex Practitioner Profile)Practitioner that is able to provide the defined services for the organization
... organization SΣ1..1Reference(PCT Organization)Organization where the roles are available
... code SΣ0..*CodeableConceptRoles which this practitioner may perform
Binding: US Core Provider Role (NUCC) (extensible): Provider role codes consisting of NUCC Health Care Provider Taxonomy Code Set for providers.


... specialty SΣ0..*CodeableConceptSpecific specialty of the practitioner
Binding: US Core Provider Speciality (NUCC) (extensible): Provider specialty codes consist of NUCC Health Care Provider Taxonomy Code Set for providers.


... location SΣ0..*Reference(Location)The location(s) at which this practitioner provides care
... healthcareService 0..*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
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ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 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..*HRexPractitionerRoleRoles/organizations the practitioner is associated with
... identifier:NPI Σ0..1IdentifierThe National Provider Identifier assigned to the provider.
.... value Σ1..1stringThe value that is unique
... practitioner Σ1..1Reference(HRex Practitioner Profile)Practitioner that is able to provide the defined services for the organization
... organization Σ1..1Reference(PCT Organization)Organization where the roles are available
... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: US Core Provider Speciality (NUCC) (extensible): Provider specialty codes consist of NUCC Health Care Provider Taxonomy Code Set for providers.


... location Σ0..*Reference(Location)The location(s) at which this practitioner provides care
... telecom ΣI0..*ContactPointContact details that are specific to the role/location/service
.... system ΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ1..1stringThe actual contact point details
... endpoint I0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

This structure is derived from HRexPractitionerRole

Summary

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

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element PractitionerRole.identifier is sliced based on the value of pattern:type

Differential View

This structure is derived from HRexPractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*HRexPractitionerRoleRoles/organizations the practitioner is associated with
... Slices for identifier 0..*IdentifierBusiness Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
.... identifier:NPI S0..1IdentifierThe National Provider Identifier assigned to the provider.
..... type 1..1CodeableConceptDescription of identifier
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
....... display1..1stringRepresentation defined by the system
Fixed Value: National provider identifier
..... system 0..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
..... value S1..1stringThe value that is unique
... organization 1..1Reference(PCT Organization)Organization where the roles are available

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*HRexPractitionerRoleRoles/organizations the practitioner is associated with
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... 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
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
.... identifier:NPI SΣ0..1IdentifierThe National Provider Identifier assigned to the provider.
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
....... display1..1stringRepresentation defined by the system
Fixed Value: National provider identifier
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active Σ0..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(HRex Practitioner Profile)Practitioner that is able to provide the defined services for the organization
... organization SΣ1..1Reference(PCT Organization)Organization where the roles are available
... code SΣ0..*CodeableConceptRoles which this practitioner may perform
Binding: US Core Provider Role (NUCC) (extensible): Provider role codes consisting of NUCC Health Care Provider Taxonomy Code Set for providers.


... specialty SΣ0..*CodeableConceptSpecific specialty of the practitioner
Binding: US Core Provider Speciality (NUCC) (extensible): Provider specialty codes consist of NUCC Health Care Provider Taxonomy Code Set for providers.


... location SΣ0..*Reference(Location)The location(s) at which this practitioner provides care
... healthcareService 0..*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
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ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 SI0..*Reference(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 / Code
PractitionerRole.languagepreferredCommonLanguages
Max Binding: AllLanguages
PractitionerRole.identifier:NPI.userequiredIdentifierUse
PractitionerRole.identifier:NPI.typeextensiblePattern: NPI("National provider identifier")
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-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-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-5PractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6PractitionerRoleA resource should have narrative for robust management
: text.`div`.exists()
pd-1PractitionerRoleSHALL have contact information or a reference to an Endpoint
: telecom or endpoint
ele-1PractitionerRole.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PractitionerRole.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PractitionerRole.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PractitionerRole.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PractitionerRole.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.identifier:NPIAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.identifier:NPI.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PractitionerRole.identifier:NPI.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PractitionerRole.identifier:NPI.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.identifier:NPI.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.identifier:NPI.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.identifier:NPI.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.identifier:NPI.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.identifier:NPI.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.activeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.practitionerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.organizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.specialtyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.locationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.healthcareServiceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.telecom.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PractitionerRole.telecom.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PractitionerRole.telecom.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.telecom.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.telecom.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.telecom.rankAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.telecom.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.availableTimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.availableTime.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PractitionerRole.availableTime.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PractitionerRole.availableTime.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PractitionerRole.availableTime.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PractitionerRole.availableTime.daysOfWeekAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.availableTime.allDayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.availableTime.availableStartTimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.availableTime.availableEndTimeAll 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())
ele-1PractitionerRole.notAvailable.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PractitionerRole.notAvailable.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PractitionerRole.notAvailable.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PractitionerRole.notAvailable.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PractitionerRole.notAvailable.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.notAvailable.duringAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.availabilityExceptionsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PractitionerRole.endpointAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())