Interweave Implementation Guide
0.1.0 - ci-build

Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the R4 profiles here.

Resource Profile: CareConnectPractitionerRole1

Official URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-PractitionerRole-1 Version: 0.1.0
Draft as of 2018-11-05 Computable Name: CareConnect-PractitionerRole-1

Copyright/Legal: Copyright © 2016 HL7 UK

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

HL7® FHIR® standard Copyright © 2011+ HL7

The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at

https://www.hl7.org/fhir/license.html

The PractitionerRole resource represents a specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

CURATED BY INTEROPen see: http://www.interopen.org/careconnect-curation-methodology/

Usage:

Formal Views of Profile Content

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

This structure is derived from PractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*PractitionerRoleRoles/organizations the practitioner is associated with
... identifier
.... system 1..1uriThe namespace for the identifier value
.... value 1..1stringThe value that is unique
.... assigner 0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... practitioner 0..1Reference(CareConnect-Practitioner-1)Practitioner that is able to provide the defined services for the organisation
... organization 0..1Reference(CareConnect-Organization-1)Organization where the roles are available
.... code:sdsJobRoleName 0..1CodeableConceptRoles which this practitioner may perform
Binding: Care Connect SDS Job Role Name (required)
..... coding 1..1CodingCode defined by a terminology system
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1
...... code 1..1codeSymbol in syntax defined by the system
...... display 1..1stringRepresentation defined by the system
... location 0..*Reference(CareConnect-Location-1)The location(s) at which this practitioner provides care

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
PractitionerRole.code:sdsJobRoleNamerequiredCare Connect SDS Job Role Name
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*PractitionerRoleRoles/organizations the practitioner is associated with
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... practitioner Σ0..1Reference(CareConnect-Practitioner-1)Practitioner that is able to provide the defined services for the organisation
... Slices for code Σ0..*CodeableConceptRoles which this practitioner may perform
Slice: Unordered, Open At End by value:coding.system
Binding: PractitionerRole (example): The role a person plays representing an organization


.... code:sdsJobRoleName Σ0..1CodeableConceptRoles which this practitioner may perform
Binding: Care Connect SDS Job Role Name (required)
..... coding Σ1..1CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
... location Σ0..*Reference(CareConnect-Location-1)The location(s) at which this practitioner provides care

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PractitionerRole.codeexamplePractitionerRole
PractitionerRole.code:sdsJobRoleNamerequiredCare Connect SDS Job Role Name

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerRoleIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorPractitionerRoleIf 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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*PractitionerRoleRoles/organizations the practitioner is associated with
... 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
... 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
... identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..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.

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... active Σ0..1booleanWhether this practitioner's record is in active use
... period Σ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner Σ0..1Reference(CareConnect-Practitioner-1)Practitioner that is able to provide the defined services for the organisation
... organization Σ0..1Reference(CareConnect-Organization-1)Organization where the roles are available
... Slices for code Σ0..*CodeableConceptRoles which this practitioner may perform
Slice: Unordered, Open At End by value:coding.system
Binding: PractitionerRole (example): The role a person plays representing an organization


.... code:sdsJobRoleName Σ0..1CodeableConceptRoles which this practitioner may perform
Binding: Care Connect SDS Job Role Name (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..1CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: Practice Setting Code Value Set (preferred): Specific specialty associated with the agency


... location Σ0..*Reference(CareConnect-Location-1)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 Σ0..*ContactPointContact details that are specific to the role/location/service
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... 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..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not availablefrom this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PractitionerRole.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
PractitionerRole.identifier.userequiredIdentifierUse
PractitionerRole.identifier.typeextensibleIdentifier Type Codes
PractitionerRole.codeexamplePractitionerRole
PractitionerRole.code:sdsJobRoleNamerequiredCare Connect SDS Job Role Name
PractitionerRole.specialtypreferredPractice Setting Code Value Set
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())

This structure is derived from PractitionerRole

Summary

Mandatory: 0 element (6 nested mandatory elements)
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element PractitionerRole.code is sliced based on the value of value:coding.system (Open at End)

Differential View

This structure is derived from PractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*PractitionerRoleRoles/organizations the practitioner is associated with
... identifier
.... system 1..1uriThe namespace for the identifier value
.... value 1..1stringThe value that is unique
.... assigner 0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... practitioner 0..1Reference(CareConnect-Practitioner-1)Practitioner that is able to provide the defined services for the organisation
... organization 0..1Reference(CareConnect-Organization-1)Organization where the roles are available
.... code:sdsJobRoleName 0..1CodeableConceptRoles which this practitioner may perform
Binding: Care Connect SDS Job Role Name (required)
..... coding 1..1CodingCode defined by a terminology system
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1
...... code 1..1codeSymbol in syntax defined by the system
...... display 1..1stringRepresentation defined by the system
... location 0..*Reference(CareConnect-Location-1)The location(s) at which this practitioner provides care

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
PractitionerRole.code:sdsJobRoleNamerequiredCare Connect SDS Job Role Name

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*PractitionerRoleRoles/organizations the practitioner is associated with
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... practitioner Σ0..1Reference(CareConnect-Practitioner-1)Practitioner that is able to provide the defined services for the organisation
... Slices for code Σ0..*CodeableConceptRoles which this practitioner may perform
Slice: Unordered, Open At End by value:coding.system
Binding: PractitionerRole (example): The role a person plays representing an organization


.... code:sdsJobRoleName Σ0..1CodeableConceptRoles which this practitioner may perform
Binding: Care Connect SDS Job Role Name (required)
..... coding Σ1..1CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
... location Σ0..*Reference(CareConnect-Location-1)The location(s) at which this practitioner provides care

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PractitionerRole.codeexamplePractitionerRole
PractitionerRole.code:sdsJobRoleNamerequiredCare Connect SDS Job Role Name

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerRoleIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorPractitionerRoleIf 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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*PractitionerRoleRoles/organizations the practitioner is associated with
... 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
... 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
... identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..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.

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... active Σ0..1booleanWhether this practitioner's record is in active use
... period Σ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner Σ0..1Reference(CareConnect-Practitioner-1)Practitioner that is able to provide the defined services for the organisation
... organization Σ0..1Reference(CareConnect-Organization-1)Organization where the roles are available
... Slices for code Σ0..*CodeableConceptRoles which this practitioner may perform
Slice: Unordered, Open At End by value:coding.system
Binding: PractitionerRole (example): The role a person plays representing an organization


.... code:sdsJobRoleName Σ0..1CodeableConceptRoles which this practitioner may perform
Binding: Care Connect SDS Job Role Name (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..1CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: Practice Setting Code Value Set (preferred): Specific specialty associated with the agency


... location Σ0..*Reference(CareConnect-Location-1)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 Σ0..*ContactPointContact details that are specific to the role/location/service
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... 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..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not availablefrom this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PractitionerRole.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
PractitionerRole.identifier.userequiredIdentifierUse
PractitionerRole.identifier.typeextensibleIdentifier Type Codes
PractitionerRole.codeexamplePractitionerRole
PractitionerRole.code:sdsJobRoleNamerequiredCare Connect SDS Job Role Name
PractitionerRole.specialtypreferredPractice Setting Code Value Set
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())

This structure is derived from PractitionerRole

Summary

Mandatory: 0 element (6 nested mandatory elements)
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element PractitionerRole.code is sliced based on the value of value:coding.system (Open at End)

 

Other representations of profile: CSV, Excel, Schematron