Consumer-Directed Payer Data Exchange
- Release 0.1.0

This page is part of the CARIN Blue Button Implementation Guide (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions

SD.9 StructureDefinition-CARIN-BB-PractitionerRole

This profile builds on USCorePractitionerRole Profile. It includes additional constraints relevant for the use cases addressed by this IG.

SD.9.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

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

Published on Mon Dec 23 19:40:59 UTC 2019 as a active by CARIN Alliance.

This profile builds on USCorePractitionerRoleProfile

Summary

Structures

This structure refers to these other structures:

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*USCorePractitionerRoleProfileRoles/organizations the practitioner is associated with
... 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(CARIN Blue Button 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
{% include StructureDefinition-CARIN-BB-PractitionerRole-pseudo-xml.xhtml %}
{% include StructureDefinition-CARIN-BB-PractitionerRole-pseudo-json.xhtml %}

Summary

Structures

This structure refers to these other structures:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*USCorePractitionerRoleProfileRoles/organizations the practitioner is associated with
... 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(CARIN Blue Button 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