Da Vinci Health Record Exchange (HRex)
0.2.0 - STU R1 - 2nd ballot

Da Vinci Health Record Exchange (HRex), published by HL7 International - Clinical Interoperability Council. This is not an authorized publication; it is the continuous build for version 0.2.0). This version is based on the current content of https://github.com/HL7/davinci-ehrx/ and changes regularly. See the Directory of published versions

Resource Profile: HRexPractitionerRole

Constraints on the US Core PractitionerRole requiring the use of Da Vinci Organization and Practitioner

The official URL for this profile is:

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

Because Da Vinci has refined the US Core organization and practitioner profiles, we also need to refine the PractitionerRole profile - because PractitionerRole binds practitioner and organization together. The only change is to require the use of the Da Vinci-specific profiles as additional constraints on the US Core ones.

Formal Views of Profile Content

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

This structure is derived from USCorePractitionerRoleProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*USCorePractitionerRoleProfileRoles/organizations the practitioner is associated with
... practitioner 1..1Reference(HRex Practitioner Profile)Practitioner that is able to provide the defined services for the organization
... organization 1..1Reference(HRex Organization Profile)Organization where the roles are available

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
... 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(HRex Practitioner Profile)Practitioner that is able to provide the defined services for the organization
... organization SΣI1..1Reference(HRex 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
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*USCorePractitionerRoleProfileRoles/organizations the practitioner is associated with
... practitioner ΣI1..1Reference(HRex Practitioner Profile)Practitioner that is able to provide the defined services for the organization
... organization ΣI1..1Reference(HRex Organization Profile)Organization where the roles are available
... code ΣI0..*CodeableConceptRoles which this practitioner may perform
Binding: US Core Provider Role (NUCC) (extensible)
... location ΣI0..*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)
.... 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

Differential View

This structure is derived from USCorePractitionerRoleProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*USCorePractitionerRoleProfileRoles/organizations the practitioner is associated with
... practitioner 1..1Reference(HRex Practitioner Profile)Practitioner that is able to provide the defined services for the organization
... organization 1..1Reference(HRex Organization Profile)Organization where the roles are available

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
... 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(HRex Practitioner Profile)Practitioner that is able to provide the defined services for the organization
... organization SΣI1..1Reference(HRex 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

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
PractitionerRole.languagepreferredCommonLanguages
Max Binding: AllLanguages
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.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())