Da Vinci Health Record Exchange (HRex)
1.1.0 - STU 1.1
Da Vinci Health Record Exchange (HRex)
1.1.0 - STU 1.1
Da Vinci Health Record Exchange (HRex), published by HL7 International / Clinical Interoperability Council. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-ehrx/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-practitionerrole | Version: 1.1.0 | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: HRexPractitionerRole | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.19.42.13 | ||||
Constraints on the US Core PractitionerRole requiring the use of Da Vinci Organization and Practitioner
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCorePractitionerRoleProfile
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
  PractitionerRole |
USCorePractitionerRoleProfile(7.0.0) | This profile also complies with the profile US Core PractitionerRole Profile (3.1.1) | ||||||
  practitioner |
1..1 | Reference(US Core Practitioner Profile(7.0.0)) | Practitioner that is able to provide the defined services for the organization | |||||
 organization |
1..1 | Reference(HRex Organization Profile) | Organization where the roles are available | |||||
 code |
0..* | CodeableConcept | Roles which this practitioner may perform Binding: Care Team Member Function  (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.
| |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI |
| PractitionerRole.code | extensible | CareTeamMemberFunction http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
C | 0..* | USCorePractitionerRoleProfile(7.0.0) | Roles/organizations the practitioner is associated with This profile also complies with the profile US Core PractitionerRole Profile (3.1.1) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management pd-1: SHALL have contact information or a reference to an Endpoint us-core-13: SHALL have a practitioner, an organization, a healthcare service, or a location. | ||||
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
| practitioner |
SΣC | 1..1 | Reference(US Core Practitioner Profile(7.0.0)) | Practitioner that is able to provide the defined services for the organization ele-1: All FHIR elements must have a @value or children | ||||
| organization |
SΣC | 1..1 | Reference(HRex Organization Profile) | Organization where the roles are available ele-1: All FHIR elements must have a @value or children | ||||
 code |
SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.
ele-1: All FHIR elements must have a @value or children | ||||
| specialty |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Healthcare Provider Taxonomy (extensible)ele-1: All FHIR elements must have a @value or children | ||||
| location |
SΣC | 0..* | Reference(US Core Location Profile(7.0.0)) | The location(s) at which this practitioner provides care ele-1: All FHIR elements must have a @value or children | ||||
 telecom |
SΣC | 0..* | ContactPoint | Contact details that are specific to the role/location/service ele-1: All FHIR elements must have a @value or children | ||||
 system |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children | ||||
| value |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children | ||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children | ||||
| endpoint |
SC | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role ele-1: All FHIR elements must have a @value or children | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI |
| PractitionerRole.code | extensible | CareTeamMemberFunction http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 | |
| PractitionerRole.specialty | extensible | HealthcareProviderTaxonomy (a valid code from http://nucc.org/provider-taxonomy)http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066 | |
| PractitionerRole.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| PractitionerRole.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | PractitionerRole | If 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-4 | error | PractitionerRole | If 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-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| pd-1 | error | PractitionerRole | SHALL have contact information or a reference to an Endpoint : telecom.exists() or endpoint.exists() | |
| us-core-13 | error | PractitionerRole | SHALL have a practitioner, an organization, a healthcare service, or a location. : practitioner.exists() or organization.exists() or healthcareService.exists() or location.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
C | 0..* | USCorePractitionerRoleProfile(7.0.0) | Roles/organizations the practitioner is associated with This profile also complies with the profile US Core PractitionerRole Profile (3.1.1) pd-1: SHALL have contact information or a reference to an Endpoint us-core-13: SHALL have a practitioner, an organization, a healthcare service, or a location. | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location | ||||
| active |
Σ | 0..1 | boolean | Whether this practitioner role record is in active use | ||||
| period |
Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||
| practitioner |
SΣC | 1..1 | Reference(US Core Practitioner Profile(7.0.0)) | Practitioner that is able to provide the defined services for the organization | ||||
| organization |
SΣC | 1..1 | Reference(HRex Organization Profile) | Organization where the roles are available | ||||
| code |
SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.
| ||||
| specialty |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Healthcare Provider Taxonomy (extensible) | ||||
| location |
SΣC | 0..* | Reference(US Core Location Profile(7.0.0)) | The location(s) at which this practitioner provides care | ||||
| healthcareService |
C | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | ||||
| telecom |
SΣC | 0..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value |
SΣ | 1..1 | string | The actual contact point details | ||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| availableTime |
0..* | BackboneElement | Times the Service Site is available | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| allDay |
0..1 | boolean | Always available? e.g. 24 hour service | |||||
| availableStartTime |
0..1 | time | Opening time of day (ignored if allDay = true) | |||||
| availableEndTime |
0..1 | time | Closing time of day (ignored if allDay = true) | |||||
| notAvailable |
0..* | BackboneElement | Not available during this time due to provided reason | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
1..1 | string | Reason presented to the user explaining why time not available | |||||
| during |
0..1 | Period | Service not available from this date | |||||
| availabilityExceptions |
0..1 | string | Description of availability exceptions | |||||
| endpoint |
SC | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| PractitionerRole.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| PractitionerRole.code | extensible | CareTeamMemberFunction http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 | ||||
| PractitionerRole.specialty | extensible | HealthcareProviderTaxonomy (a valid code from http://nucc.org/provider-taxonomy)http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066 | ||||
| PractitionerRole.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| PractitionerRole.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | PractitionerRole | If 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-4 | error | PractitionerRole | If 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-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| pd-1 | error | PractitionerRole | SHALL have contact information or a reference to an Endpoint : telecom.exists() or endpoint.exists() | |
| us-core-13 | error | PractitionerRole | SHALL have a practitioner, an organization, a healthcare service, or a location. : practitioner.exists() or organization.exists() or healthcareService.exists() or location.exists() |
This structure is derived from USCorePractitionerRoleProfile
Summary
Mandatory: 2 elements
Structures
This structure refers to these other structures:
Maturity: 2
Differential View
This structure is derived from USCorePractitionerRoleProfile
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
USCorePractitionerRoleProfile(7.0.0) | This profile also complies with the profile US Core PractitionerRole Profile (3.1.1) | ||||||
| practitioner |
1..1 | Reference(US Core Practitioner Profile(7.0.0)) | Practitioner that is able to provide the defined services for the organization | |||||
| organization |
1..1 | Reference(HRex Organization Profile) | Organization where the roles are available | |||||
| code |
0..* | CodeableConcept | Roles which this practitioner may perform Binding: Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.
| |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI |
| PractitionerRole.code | extensible | CareTeamMemberFunction http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
C | 0..* | USCorePractitionerRoleProfile(7.0.0) | Roles/organizations the practitioner is associated with This profile also complies with the profile US Core PractitionerRole Profile (3.1.1) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management pd-1: SHALL have contact information or a reference to an Endpoint us-core-13: SHALL have a practitioner, an organization, a healthcare service, or a location. | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
| practitioner |
SΣC | 1..1 | Reference(US Core Practitioner Profile(7.0.0)) | Practitioner that is able to provide the defined services for the organization ele-1: All FHIR elements must have a @value or children | ||||
| organization |
SΣC | 1..1 | Reference(HRex Organization Profile) | Organization where the roles are available ele-1: All FHIR elements must have a @value or children | ||||
| code |
SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.
ele-1: All FHIR elements must have a @value or children | ||||
| specialty |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Healthcare Provider Taxonomy (extensible)ele-1: All FHIR elements must have a @value or children | ||||
| location |
SΣC | 0..* | Reference(US Core Location Profile(7.0.0)) | The location(s) at which this practitioner provides care ele-1: All FHIR elements must have a @value or children | ||||
| telecom |
SΣC | 0..* | ContactPoint | Contact details that are specific to the role/location/service ele-1: All FHIR elements must have a @value or children | ||||
| system |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children | ||||
| value |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children | ||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children | ||||
| endpoint |
SC | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role ele-1: All FHIR elements must have a @value or children | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI |
| PractitionerRole.code | extensible | CareTeamMemberFunction http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 | |
| PractitionerRole.specialty | extensible | HealthcareProviderTaxonomy (a valid code from http://nucc.org/provider-taxonomy)http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066 | |
| PractitionerRole.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| PractitionerRole.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | PractitionerRole | If 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-4 | error | PractitionerRole | If 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-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| pd-1 | error | PractitionerRole | SHALL have contact information or a reference to an Endpoint : telecom.exists() or endpoint.exists() | |
| us-core-13 | error | PractitionerRole | SHALL have a practitioner, an organization, a healthcare service, or a location. : practitioner.exists() or organization.exists() or healthcareService.exists() or location.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
C | 0..* | USCorePractitionerRoleProfile(7.0.0) | Roles/organizations the practitioner is associated with This profile also complies with the profile US Core PractitionerRole Profile (3.1.1) pd-1: SHALL have contact information or a reference to an Endpoint us-core-13: SHALL have a practitioner, an organization, a healthcare service, or a location. | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location | ||||
| active |
Σ | 0..1 | boolean | Whether this practitioner role record is in active use | ||||
| period |
Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||
| practitioner |
SΣC | 1..1 | Reference(US Core Practitioner Profile(7.0.0)) | Practitioner that is able to provide the defined services for the organization | ||||
| organization |
SΣC | 1..1 | Reference(HRex Organization Profile) | Organization where the roles are available | ||||
| code |
SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.
| ||||
| specialty |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Healthcare Provider Taxonomy (extensible) | ||||
| location |
SΣC | 0..* | Reference(US Core Location Profile(7.0.0)) | The location(s) at which this practitioner provides care | ||||
| healthcareService |
C | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | ||||
| telecom |
SΣC | 0..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value |
SΣ | 1..1 | string | The actual contact point details | ||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| availableTime |
0..* | BackboneElement | Times the Service Site is available | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| allDay |
0..1 | boolean | Always available? e.g. 24 hour service | |||||
| availableStartTime |
0..1 | time | Opening time of day (ignored if allDay = true) | |||||
| availableEndTime |
0..1 | time | Closing time of day (ignored if allDay = true) | |||||
| notAvailable |
0..* | BackboneElement | Not available during this time due to provided reason | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
1..1 | string | Reason presented to the user explaining why time not available | |||||
| during |
0..1 | Period | Service not available from this date | |||||
| availabilityExceptions |
0..1 | string | Description of availability exceptions | |||||
| endpoint |
SC | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| PractitionerRole.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| PractitionerRole.code | extensible | CareTeamMemberFunction http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 | ||||
| PractitionerRole.specialty | extensible | HealthcareProviderTaxonomy (a valid code from http://nucc.org/provider-taxonomy)http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066 | ||||
| PractitionerRole.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| PractitionerRole.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | PractitionerRole | If 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-4 | error | PractitionerRole | If 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-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| pd-1 | error | PractitionerRole | SHALL have contact information or a reference to an Endpoint : telecom.exists() or endpoint.exists() | |
| us-core-13 | error | PractitionerRole | SHALL have a practitioner, an organization, a healthcare service, or a location. : practitioner.exists() or organization.exists() or healthcareService.exists() or location.exists() |
This structure is derived from USCorePractitionerRoleProfile
Summary
Mandatory: 2 elements
Structures
This structure refers to these other structures:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2019+ HL7 International / Clinical Interoperability Council. Package hl7.fhir.us.davinci-hrex#1.1.0 based on FHIR 4.0.1. Generated 2024-12-10
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change