CARIN Consumer Directed Payer Data Exchange
0.3.1 - STU1

CARIN Consumer Directed Payer Data Exchange, published by HL7 Financial Management Working Group. This is not an authorized publication; it is the continuous build for version 0.3.1). This version is based on the current content of https://github.com/HL7/carin-bb/ and changes regularly. See the Directory of published versions

Resource Profile: CARINBBPractitionerRole

CARIN Blue Button PractitionerRole Profile.

The official URL for this profile is:

http://hl7.org/fhir/us/carin-bb/StructureDefinition/CARIN-BB-PractitionerRole

Formal Views of Profile Content

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

This structure is derived from USCorePractitionerRoleProfile

Summary

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

Structures

This structure refers to these other structures:

This structure is derived from USCorePractitionerRoleProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*USCorePractitionerRoleProfileRoles/organizations the practitioner is associated with
... meta
.... lastUpdated S1..1instantWhen the resource version last changed
.... profile S1..*canonical(StructureDefinition)Profiles this resource claims to conform to
... practitioner 1..1Reference(CARIN BB Practitioner)Practitioner that is able to provide the defined services for the organization
... organization 1..1Reference(CARIN BB Organization)Organization where the roles are available
... specialty 0..*CodeableConceptSpecific specialty of the practitioner
Binding: US Core Provider Speciality (NUCC) (required)
... location 0..*Reference(CARIN BB Location)The location(s) at which this practitioner provides care

doco Documentation for this format
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
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId ΣI0..1idVersion specific identifier
.... lastUpdated SΣI1..1instantWhen the resource version last changed
.... source ΣI0..1uriIdentifies where the resource comes from
.... profile SΣI1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security ΣI0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag ΣI0..*CodingTags applied to this resource
Binding: CommonTags (example)
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... 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(CARIN BB Practitioner)Practitioner that is able to provide the defined services for the organization
... organization SΣI1..1Reference(CARIN BB Organization)Organization where the roles are available
... code SΣI0..*CodeableConceptRoles which this practitioner may perform
Binding: US Core Provider Role (NUCC) (required)
... specialty SΣI0..*CodeableConceptSpecific specialty of the practitioner
Binding: US Core Provider Speciality (NUCC) (required)
... location SΣI0..*Reference(CARIN BB 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
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*USCorePractitionerRoleProfileRoles/organizations the practitioner is associated with
... meta ΣI0..1MetaMetadata about the resource
.... lastUpdated ΣI1..1instantWhen the resource version last changed
.... profile ΣI1..*canonical(StructureDefinition)Profiles this resource claims to conform to
... practitioner ΣI1..1Reference(CARIN BB Practitioner)Practitioner that is able to provide the defined services for the organization
... organization ΣI1..1Reference(CARIN BB Organization)Organization where the roles are available
... specialty ΣI0..*CodeableConceptSpecific specialty of the practitioner
Binding: US Core Provider Speciality (NUCC) (required)
... location ΣI0..*Reference(CARIN BB 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)
.... value ΣI1..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 USCorePractitionerRoleProfile

Summary

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

Structures

This structure refers to these other structures:

Differential View

This structure is derived from USCorePractitionerRoleProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*USCorePractitionerRoleProfileRoles/organizations the practitioner is associated with
... meta
.... lastUpdated S1..1instantWhen the resource version last changed
.... profile S1..*canonical(StructureDefinition)Profiles this resource claims to conform to
... practitioner 1..1Reference(CARIN BB Practitioner)Practitioner that is able to provide the defined services for the organization
... organization 1..1Reference(CARIN BB Organization)Organization where the roles are available
... specialty 0..*CodeableConceptSpecific specialty of the practitioner
Binding: US Core Provider Speciality (NUCC) (required)
... location 0..*Reference(CARIN BB Location)The location(s) at which this practitioner provides care

doco Documentation for this format

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
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId ΣI0..1idVersion specific identifier
.... lastUpdated SΣI1..1instantWhen the resource version last changed
.... source ΣI0..1uriIdentifies where the resource comes from
.... profile SΣI1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security ΣI0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag ΣI0..*CodingTags applied to this resource
Binding: CommonTags (example)
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... 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(CARIN BB Practitioner)Practitioner that is able to provide the defined services for the organization
... organization SΣI1..1Reference(CARIN BB Organization)Organization where the roles are available
... code SΣI0..*CodeableConceptRoles which this practitioner may perform
Binding: US Core Provider Role (NUCC) (required)
... specialty SΣI0..*CodeableConceptSpecific specialty of the practitioner
Binding: US Core Provider Speciality (NUCC) (required)
... location SΣI0..*Reference(CARIN BB 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

 

Other representations of profile: Schematron

Terminology Bindings

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