Da Vinci PDex Plan Net
1.2.0 - STU 2 (ci-build)
Da Vinci PDex Plan Net
1.2.0 - STU 2 (ci-build)
Da Vinci PDex Plan Net, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 1.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-pdex-plan-net/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-PractitionerRole | Version: 1.2.0 | |||
| Standards status: Trial-use | Computable Name: PlannetPractitionerRole | |||
PractitionerRole typically describes details about a provider. When the provider is a practitioner, there may be a relationship to an organization. A provider renders services to patients at a location. Practitioner participation in healthcare provider insurance networks may be direct or through their role at an organization. PractitionerRole involves either the actual or potential (hence the optionality on Practitioner) of an individual to play this role on behalf of or under the auspices of an organization. The absence of a Practitioner resource does not imply that the Organization itself is playing the role of a Practitioner, instead it implies that that role has been established by the Organization and MAY apply that to a specific Practitioner.
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 |
C | 0..* | USCorePractitionerRoleProfile(7.0.0) | Roles/organizations the practitioner is associated with practitioner-or-organization-or-healthcareservice-or-location: If PlannetPractitionerRole.practitioner is absent ( PlannetPractitionerRole.organization, PlannetPractitionerRole.healthcareservice, PlannetPractitionerRole.location) must be present |
  meta |
||||
  lastUpdated |
1..1 | instant | When the resource version last changed | |
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
  newpatients |
S | 0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients |
| network-reference |
S | 0..1 | Reference(Plan-Net Network) | NetworkReference URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/network-reference |
 qualification |
S | 0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/qualification |
   Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | Extension | Extension | |
 value[x] |
1..1 | CodeableConcept | Value of extension Binding: Individual Specialties, Degrees, Licenses, and Certificates VS (extensible) | |
| identifier |
||||
 type |
S | 0..1 | CodeableConcept | Description of identifier |
| value |
S | 0..1 | string | The value that is unique |
| active |
S | 1..1 | boolean | Whether this practitioner role record is in active use Required Pattern: true |
| period |
S | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
 practitioner |
0..1 | Reference(Plan-Net Practitioner) | Practitioner that is able to provide the defined services for the organization | |
| organization |
0..1 | Reference(Plan-Net Organization) | Organization where the roles are available | |
| code |
0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole Code VS (required) | |
| specialty |
0..* | CodeableConcept | Specific specialty of the practitioner Binding: Individual and Group Specialties (required) | |
| location |
0..* | Reference(Plan-Net Location) | The location(s) at which this practitioner provides care | |
| healthcareService |
S | 0..* | Reference(Plan-Net HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) |
| telecom |
||||
| Slices for extension |
Content/Rules for all slices | |||
| contactpoint-availabletime |
S | 0..* | (Complex) | Contactpoint Availabletime URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime |
 via-intermediary |
S | 0..* | Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization) | Via Intermediary URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary |
| rank |
S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| availableTime |
S | 0..* | BackboneElement | Times the Service Site is available |
| daysOfWeek |
S | 0..* | code | mon | tue | wed | thu | fri | sat | sun |
| allDay |
S | 0..1 | boolean | Always available? e.g. 24 hour service |
| availableStartTime |
S | 0..1 | time | Opening time of day (ignored if allDay = true) |
| availableEndTime |
S | 0..1 | time | Closing time of day (ignored if allDay = true) |
| notAvailable |
S | 0..* | BackboneElement | Not available during this time due to provided reason |
| description |
S | 1..1 | string | Reason presented to the user explaining why time not available |
| during |
S | 0..1 | Period | Service not available from this date |
| endpoint |
0..* | Reference(Plan-Net Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| PractitionerRole.extension:qualification.extension:code.value[x] | extensible | IndividualSpecialtyAndDegreeLicenseCertificateVShttp://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/IndividualSpecialtyAndDegreeLicenseCertificateVSfrom this IG | |
| PractitionerRole.code | required | PractitionerRoleVShttp://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/PractitionerRoleVSfrom this IG | |
| PractitionerRole.specialty | required | IndividualAndGroupSpecialtiesVShttp://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/IndividualAndGroupSpecialtiesVSfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| practitioner-or-organization-or-healthcareservice-or-location | error | PractitionerRole | If PlannetPractitionerRole.practitioner is absent ( PlannetPractitionerRole.organization, PlannetPractitionerRole.healthcareservice, PlannetPractitionerRole.location) must be present : 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 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. practitioner-or-organization-or-healthcareservice-or-location: If PlannetPractitionerRole.practitioner is absent ( PlannetPractitionerRole.organization, PlannetPractitionerRole.healthcareservice, PlannetPractitionerRole.location) must be present |
 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 |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| newpatients |
SC | 0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both new-patients-characteristics: If no new patients are accepted, no characteristics are allowed |
| network-reference |
S | 0..1 | Reference(Plan-Net Network) | NetworkReference URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/network-reference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| qualification |
S | 0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/qualification ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
  extension:identifier |
S | 0..* | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
  extension |
0..0 | |||
| url |
1..1 | uri | "identifier" | |
 value[x] |
1..1 | Identifier | Value of extension ele-1: All FHIR elements must have a @value or children | |
| extension:code |
S | 1..1 | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extension |
0..0 | |||
| url |
1..1 | uri | "code" | |
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: Individual Specialties, Degrees, Licenses, and Certificates VS (extensible) ele-1: All FHIR elements must have a @value or children | |
| extension:issuer |
S | 0..1 | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extension |
0..0 | |||
| url |
1..1 | uri | "issuer" | |
| value[x] |
1..1 | Reference(Plan-Net Organization) | Value of extension ele-1: All FHIR elements must have a @value or children | |
| extension:status |
S | 1..1 | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extension |
0..0 | |||
| url |
1..1 | uri | "status" | |
| value[x] |
1..1 | code | Value of extension Binding: Qualification Status VS (required) ele-1: All FHIR elements must have a @value or children Fixed Value: active | |
| extension:period |
S | 0..1 | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extension |
0..0 | |||
| url |
1..1 | uri | "period" | |
| value[x] |
1..1 | Period | Value of extension ele-1: All FHIR elements must have a @value or children | |
| extension:whereValid |
S | 0..* | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extension |
0..0 | |||
| url |
1..1 | uri | "whereValid" | |
 value[x] |
1..1 | Value of extension Binding: USPS Two Letter Alphabetic Codes (required) ele-1: All FHIR elements must have a @value or children | ||
| valueCodeableConcept |
CodeableConcept | |||
| valueReference |
Reference(Plan-Net Location) | |||
| url |
1..1 | uri | "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/qualification" | |
 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 |
| identifier |
Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location ele-1: All FHIR elements must have a @value or children |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
| type |
SΣ | 0..1 | CodeableConcept | Description 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. ele-1: All FHIR elements must have a @value or children |
| value |
SΣ | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
| active |
SΣ | 1..1 | boolean | Whether this practitioner role record is in active use ele-1: All FHIR elements must have a @value or children Required Pattern: true |
| period |
SΣ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) ele-1: All FHIR elements must have a @value or children |
| practitioner |
SΣC | 0..1 | Reference(Plan-Net Practitioner) | 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 | 0..1 | Reference(Plan-Net Organization) | 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: PractitionerRole Code VS (required) ele-1: All FHIR elements must have a @value or children |
| specialty |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Individual and Group Specialties (required) ele-1: All FHIR elements must have a @value or children |
| location |
SΣC | 0..* | Reference(Plan-Net Location) | The location(s) at which this practitioner provides care ele-1: All FHIR elements must have a @value or children |
| healthcareService |
SC | 0..* | Reference(Plan-Net HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) 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 |
| Slices for extension |
Content/Rules for all slices | |||
| contactpoint-availabletime |
S | 0..* | (Complex) | Contactpoint Availabletime URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| via-intermediary |
S | 0..* | Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization) | Via Intermediary URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| 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 |
| rank |
SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) ele-1: All FHIR elements must have a @value or children |
| availableTime |
S | 0..* | BackboneElement | Times the Service Site is available ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| daysOfWeek |
S | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. ele-1: All FHIR elements must have a @value or children |
| allDay |
S | 0..1 | boolean | Always available? e.g. 24 hour service ele-1: All FHIR elements must have a @value or children |
| availableStartTime |
S | 0..1 | time | Opening time of day (ignored if allDay = true) ele-1: All FHIR elements must have a @value or children |
| availableEndTime |
S | 0..1 | time | Closing time of day (ignored if allDay = true) ele-1: All FHIR elements must have a @value or children |
| notAvailable |
S | 0..* | BackboneElement | Not available during this time due to provided reason ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| description |
S | 1..1 | string | Reason presented to the user explaining why time not available ele-1: All FHIR elements must have a @value or children |
| during |
S | 0..1 | Period | Service not available from this date ele-1: All FHIR elements must have a @value or children |
| endpoint |
SC | 0..* | Reference(Plan-Net 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 / Code | URI |
| PractitionerRole.extension:qualification.extension:code.value[x] | extensible | IndividualSpecialtyAndDegreeLicenseCertificateVShttp://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/IndividualSpecialtyAndDegreeLicenseCertificateVSfrom this IG | |
| PractitionerRole.extension:qualification.extension:status.value[x] | required | Fixed Value: activehttp://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/QualificationStatusVSfrom this IG | |
| PractitionerRole.extension:qualification.extension:whereValid.value[x] | required | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state | |
| PractitionerRole.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| PractitionerRole.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| PractitionerRole.code | required | PractitionerRoleVShttp://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/PractitionerRoleVSfrom this IG | |
| PractitionerRole.specialty | required | IndividualAndGroupSpecialtiesVShttp://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/IndividualAndGroupSpecialtiesVSfrom this IG | |
| 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 |
| practitioner-or-organization-or-healthcareservice-or-location | error | PractitionerRole | If PlannetPractitionerRole.practitioner is absent ( PlannetPractitionerRole.organization, PlannetPractitionerRole.healthcareservice, PlannetPractitionerRole.location) must be present : 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 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. practitioner-or-organization-or-healthcareservice-or-location: If PlannetPractitionerRole.practitioner is absent ( PlannetPractitionerRole.organization, PlannetPractitionerRole.healthcareservice, PlannetPractitionerRole.location) must be present | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 1..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| newpatients |
SC | 0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients new-patients-characteristics: If no new patients are accepted, no characteristics are allowed | ||||
| network-reference |
S | 0..1 | Reference(Plan-Net Network) | NetworkReference URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/network-reference | ||||
| qualification |
S | 0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/qualification | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:identifier |
S | 0..* | Extension | Extension | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "identifier" | |||||
| value[x] |
1..1 | Identifier | Value of extension | |||||
| extension:code |
S | 1..1 | Extension | Extension | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "code" | |||||
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: Individual Specialties, Degrees, Licenses, and Certificates VS (extensible) | |||||
| extension:issuer |
S | 0..1 | Extension | Extension | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "issuer" | |||||
| value[x] |
1..1 | Reference(Plan-Net Organization) | Value of extension | |||||
| extension:status |
S | 1..1 | Extension | Extension | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "status" | |||||
| value[x] |
1..1 | code | Value of extension Binding: Qualification Status VS (required) Fixed Value: active | |||||
| extension:period |
S | 0..1 | Extension | Extension | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "period" | |||||
| value[x] |
1..1 | Period | Value of extension | |||||
| extension:whereValid |
S | 0..* | Extension | Extension | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "whereValid" | |||||
| value[x] |
1..1 | Value of extension Binding: USPS Two Letter Alphabetic Codes (required) | ||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueReference |
Reference(Plan-Net Location) | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/qualification" | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
SΣ | 0..1 | CodeableConcept | Description 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 |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active |
SΣ | 1..1 | boolean | Whether this practitioner role record is in active use Required Pattern: true | ||||
| period |
SΣ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||
| practitioner |
SΣC | 0..1 | Reference(Plan-Net Practitioner) | Practitioner that is able to provide the defined services for the organization | ||||
| organization |
SΣC | 0..1 | Reference(Plan-Net Organization) | Organization where the roles are available | ||||
| code |
SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole Code VS (required) | ||||
| specialty |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Individual and Group Specialties (required) | ||||
| location |
SΣC | 0..* | Reference(Plan-Net Location) | The location(s) at which this practitioner provides care | ||||
| healthcareService |
SC | 0..* | Reference(Plan-Net 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 | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contactpoint-availabletime |
S | 0..* | (Complex) | Contactpoint Availabletime URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime | ||||
| via-intermediary |
S | 0..* | Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization) | Via Intermediary URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary | ||||
| 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 |
SΣ | 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 |
S | 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 |
S | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | ||||
| allDay |
S | 0..1 | boolean | Always available? e.g. 24 hour service | ||||
| availableStartTime |
S | 0..1 | time | Opening time of day (ignored if allDay = true) | ||||
| availableEndTime |
S | 0..1 | time | Closing time of day (ignored if allDay = true) | ||||
| notAvailable |
S | 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 |
S | 1..1 | string | Reason presented to the user explaining why time not available | ||||
| during |
S | 0..1 | Period | Service not available from this date | ||||
| availabilityExceptions |
0..1 | string | Description of availability exceptions | |||||
| endpoint |
SC | 0..* | Reference(Plan-Net Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| PractitionerRole.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| PractitionerRole.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| PractitionerRole.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| PractitionerRole.extension:qualification.extension:code.value[x] | extensible | IndividualSpecialtyAndDegreeLicenseCertificateVShttp://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/IndividualSpecialtyAndDegreeLicenseCertificateVSfrom this IG | ||||
| PractitionerRole.extension:qualification.extension:status.value[x] | required | Fixed Value: activehttp://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/QualificationStatusVSfrom this IG | ||||
| PractitionerRole.extension:qualification.extension:whereValid.value[x] | required | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state | ||||
| PractitionerRole.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| PractitionerRole.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| PractitionerRole.code | required | PractitionerRoleVShttp://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/PractitionerRoleVSfrom this IG | ||||
| PractitionerRole.specialty | required | IndividualAndGroupSpecialtiesVShttp://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/IndividualAndGroupSpecialtiesVSfrom this IG | ||||
| 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 |
| practitioner-or-organization-or-healthcareservice-or-location | error | PractitionerRole | If PlannetPractitionerRole.practitioner is absent ( PlannetPractitionerRole.organization, PlannetPractitionerRole.healthcareservice, PlannetPractitionerRole.location) must be present : practitioner.exists() or (organization.exists() or healthcareService.exists() or location.exists()) |
This structure is derived from USCorePractitionerRoleProfile
Summary
Mandatory: 1 element(1 nested mandatory element)
Must-Support: 19 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from USCorePractitionerRoleProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole |
C | 0..* | USCorePractitionerRoleProfile(7.0.0) | Roles/organizations the practitioner is associated with practitioner-or-organization-or-healthcareservice-or-location: If PlannetPractitionerRole.practitioner is absent ( PlannetPractitionerRole.organization, PlannetPractitionerRole.healthcareservice, PlannetPractitionerRole.location) must be present |
| meta |
||||
| lastUpdated |
1..1 | instant | When the resource version last changed | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| newpatients |
S | 0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients |
| network-reference |
S | 0..1 | Reference(Plan-Net Network) | NetworkReference URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/network-reference |
| qualification |
S | 0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/qualification |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | Extension | Extension | |
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: Individual Specialties, Degrees, Licenses, and Certificates VS (extensible) | |
| identifier |
||||
| type |
S | 0..1 | CodeableConcept | Description of identifier |
| value |
S | 0..1 | string | The value that is unique |
| active |
S | 1..1 | boolean | Whether this practitioner role record is in active use Required Pattern: true |
| period |
S | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
| practitioner |
0..1 | Reference(Plan-Net Practitioner) | Practitioner that is able to provide the defined services for the organization | |
| organization |
0..1 | Reference(Plan-Net Organization) | Organization where the roles are available | |
| code |
0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole Code VS (required) | |
| specialty |
0..* | CodeableConcept | Specific specialty of the practitioner Binding: Individual and Group Specialties (required) | |
| location |
0..* | Reference(Plan-Net Location) | The location(s) at which this practitioner provides care | |
| healthcareService |
S | 0..* | Reference(Plan-Net HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) |
| telecom |
||||
| Slices for extension |
Content/Rules for all slices | |||
| contactpoint-availabletime |
S | 0..* | (Complex) | Contactpoint Availabletime URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime |
| via-intermediary |
S | 0..* | Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization) | Via Intermediary URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary |
| rank |
S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| availableTime |
S | 0..* | BackboneElement | Times the Service Site is available |
| daysOfWeek |
S | 0..* | code | mon | tue | wed | thu | fri | sat | sun |
| allDay |
S | 0..1 | boolean | Always available? e.g. 24 hour service |
| availableStartTime |
S | 0..1 | time | Opening time of day (ignored if allDay = true) |
| availableEndTime |
S | 0..1 | time | Closing time of day (ignored if allDay = true) |
| notAvailable |
S | 0..* | BackboneElement | Not available during this time due to provided reason |
| description |
S | 1..1 | string | Reason presented to the user explaining why time not available |
| during |
S | 0..1 | Period | Service not available from this date |
| endpoint |
0..* | Reference(Plan-Net Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| PractitionerRole.extension:qualification.extension:code.value[x] | extensible | IndividualSpecialtyAndDegreeLicenseCertificateVShttp://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/IndividualSpecialtyAndDegreeLicenseCertificateVSfrom this IG | |
| PractitionerRole.code | required | PractitionerRoleVShttp://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/PractitionerRoleVSfrom this IG | |
| PractitionerRole.specialty | required | IndividualAndGroupSpecialtiesVShttp://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/IndividualAndGroupSpecialtiesVSfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| practitioner-or-organization-or-healthcareservice-or-location | error | PractitionerRole | If PlannetPractitionerRole.practitioner is absent ( PlannetPractitionerRole.organization, PlannetPractitionerRole.healthcareservice, PlannetPractitionerRole.location) must be present : practitioner.exists() or (organization.exists() or healthcareService.exists() or location.exists()) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole |
C | 0..* | USCorePractitionerRoleProfile(7.0.0) | Roles/organizations the practitioner is associated with 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. practitioner-or-organization-or-healthcareservice-or-location: If PlannetPractitionerRole.practitioner is absent ( PlannetPractitionerRole.organization, PlannetPractitionerRole.healthcareservice, PlannetPractitionerRole.location) must be present |
| 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 |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| newpatients |
SC | 0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both new-patients-characteristics: If no new patients are accepted, no characteristics are allowed |
| network-reference |
S | 0..1 | Reference(Plan-Net Network) | NetworkReference URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/network-reference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| qualification |
S | 0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/qualification ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension:identifier |
S | 0..* | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extension |
0..0 | |||
| url |
1..1 | uri | "identifier" | |
| value[x] |
1..1 | Identifier | Value of extension ele-1: All FHIR elements must have a @value or children | |
| extension:code |
S | 1..1 | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extension |
0..0 | |||
| url |
1..1 | uri | "code" | |
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: Individual Specialties, Degrees, Licenses, and Certificates VS (extensible) ele-1: All FHIR elements must have a @value or children | |
| extension:issuer |
S | 0..1 | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extension |
0..0 | |||
| url |
1..1 | uri | "issuer" | |
| value[x] |
1..1 | Reference(Plan-Net Organization) | Value of extension ele-1: All FHIR elements must have a @value or children | |
| extension:status |
S | 1..1 | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extension |
0..0 | |||
| url |
1..1 | uri | "status" | |
| value[x] |
1..1 | code | Value of extension Binding: Qualification Status VS (required) ele-1: All FHIR elements must have a @value or children Fixed Value: active | |
| extension:period |
S | 0..1 | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extension |
0..0 | |||
| url |
1..1 | uri | "period" | |
| value[x] |
1..1 | Period | Value of extension ele-1: All FHIR elements must have a @value or children | |
| extension:whereValid |
S | 0..* | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extension |
0..0 | |||
| url |
1..1 | uri | "whereValid" | |
| value[x] |
1..1 | Value of extension Binding: USPS Two Letter Alphabetic Codes (required) ele-1: All FHIR elements must have a @value or children | ||
| valueCodeableConcept |
CodeableConcept | |||
| valueReference |
Reference(Plan-Net Location) | |||
| url |
1..1 | uri | "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/qualification" | |
| 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 |
| identifier |
Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location ele-1: All FHIR elements must have a @value or children |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
| type |
SΣ | 0..1 | CodeableConcept | Description 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. ele-1: All FHIR elements must have a @value or children |
| value |
SΣ | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
| active |
SΣ | 1..1 | boolean | Whether this practitioner role record is in active use ele-1: All FHIR elements must have a @value or children Required Pattern: true |
| period |
SΣ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) ele-1: All FHIR elements must have a @value or children |
| practitioner |
SΣC | 0..1 | Reference(Plan-Net Practitioner) | 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 | 0..1 | Reference(Plan-Net Organization) | 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: PractitionerRole Code VS (required) ele-1: All FHIR elements must have a @value or children |
| specialty |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Individual and Group Specialties (required) ele-1: All FHIR elements must have a @value or children |
| location |
SΣC | 0..* | Reference(Plan-Net Location) | The location(s) at which this practitioner provides care ele-1: All FHIR elements must have a @value or children |
| healthcareService |
SC | 0..* | Reference(Plan-Net HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) 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 |
| Slices for extension |
Content/Rules for all slices | |||
| contactpoint-availabletime |
S | 0..* | (Complex) | Contactpoint Availabletime URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| via-intermediary |
S | 0..* | Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization) | Via Intermediary URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| 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 |
| rank |
SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) ele-1: All FHIR elements must have a @value or children |
| availableTime |
S | 0..* | BackboneElement | Times the Service Site is available ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| daysOfWeek |
S | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. ele-1: All FHIR elements must have a @value or children |
| allDay |
S | 0..1 | boolean | Always available? e.g. 24 hour service ele-1: All FHIR elements must have a @value or children |
| availableStartTime |
S | 0..1 | time | Opening time of day (ignored if allDay = true) ele-1: All FHIR elements must have a @value or children |
| availableEndTime |
S | 0..1 | time | Closing time of day (ignored if allDay = true) ele-1: All FHIR elements must have a @value or children |
| notAvailable |
S | 0..* | BackboneElement | Not available during this time due to provided reason ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| description |
S | 1..1 | string | Reason presented to the user explaining why time not available ele-1: All FHIR elements must have a @value or children |
| during |
S | 0..1 | Period | Service not available from this date ele-1: All FHIR elements must have a @value or children |
| endpoint |
SC | 0..* | Reference(Plan-Net 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 / Code | URI |
| PractitionerRole.extension:qualification.extension:code.value[x] | extensible | IndividualSpecialtyAndDegreeLicenseCertificateVShttp://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/IndividualSpecialtyAndDegreeLicenseCertificateVSfrom this IG | |
| PractitionerRole.extension:qualification.extension:status.value[x] | required | Fixed Value: activehttp://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/QualificationStatusVSfrom this IG | |
| PractitionerRole.extension:qualification.extension:whereValid.value[x] | required | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state | |
| PractitionerRole.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| PractitionerRole.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| PractitionerRole.code | required | PractitionerRoleVShttp://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/PractitionerRoleVSfrom this IG | |
| PractitionerRole.specialty | required | IndividualAndGroupSpecialtiesVShttp://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/IndividualAndGroupSpecialtiesVSfrom this IG | |
| 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 |
| practitioner-or-organization-or-healthcareservice-or-location | error | PractitionerRole | If PlannetPractitionerRole.practitioner is absent ( PlannetPractitionerRole.organization, PlannetPractitionerRole.healthcareservice, PlannetPractitionerRole.location) must be present : 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 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. practitioner-or-organization-or-healthcareservice-or-location: If PlannetPractitionerRole.practitioner is absent ( PlannetPractitionerRole.organization, PlannetPractitionerRole.healthcareservice, PlannetPractitionerRole.location) must be present | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 1..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| newpatients |
SC | 0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients new-patients-characteristics: If no new patients are accepted, no characteristics are allowed | ||||
| network-reference |
S | 0..1 | Reference(Plan-Net Network) | NetworkReference URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/network-reference | ||||
| qualification |
S | 0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/qualification | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:identifier |
S | 0..* | Extension | Extension | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "identifier" | |||||
| value[x] |
1..1 | Identifier | Value of extension | |||||
| extension:code |
S | 1..1 | Extension | Extension | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "code" | |||||
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: Individual Specialties, Degrees, Licenses, and Certificates VS (extensible) | |||||
| extension:issuer |
S | 0..1 | Extension | Extension | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "issuer" | |||||
| value[x] |
1..1 | Reference(Plan-Net Organization) | Value of extension | |||||
| extension:status |
S | 1..1 | Extension | Extension | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "status" | |||||
| value[x] |
1..1 | code | Value of extension Binding: Qualification Status VS (required) Fixed Value: active | |||||
| extension:period |
S | 0..1 | Extension | Extension | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "period" | |||||
| value[x] |
1..1 | Period | Value of extension | |||||
| extension:whereValid |
S | 0..* | Extension | Extension | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "whereValid" | |||||
| value[x] |
1..1 | Value of extension Binding: USPS Two Letter Alphabetic Codes (required) | ||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueReference |
Reference(Plan-Net Location) | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/qualification" | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
SΣ | 0..1 | CodeableConcept | Description 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 |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active |
SΣ | 1..1 | boolean | Whether this practitioner role record is in active use Required Pattern: true | ||||
| period |
SΣ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||
| practitioner |
SΣC | 0..1 | Reference(Plan-Net Practitioner) | Practitioner that is able to provide the defined services for the organization | ||||
| organization |
SΣC | 0..1 | Reference(Plan-Net Organization) | Organization where the roles are available | ||||
| code |
SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole Code VS (required) | ||||
| specialty |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Individual and Group Specialties (required) | ||||
| location |
SΣC | 0..* | Reference(Plan-Net Location) | The location(s) at which this practitioner provides care | ||||
| healthcareService |
SC | 0..* | Reference(Plan-Net 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 | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contactpoint-availabletime |
S | 0..* | (Complex) | Contactpoint Availabletime URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime | ||||
| via-intermediary |
S | 0..* | Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization) | Via Intermediary URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary | ||||
| 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 |
SΣ | 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 |
S | 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 |
S | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | ||||
| allDay |
S | 0..1 | boolean | Always available? e.g. 24 hour service | ||||
| availableStartTime |
S | 0..1 | time | Opening time of day (ignored if allDay = true) | ||||
| availableEndTime |
S | 0..1 | time | Closing time of day (ignored if allDay = true) | ||||
| notAvailable |
S | 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 |
S | 1..1 | string | Reason presented to the user explaining why time not available | ||||
| during |
S | 0..1 | Period | Service not available from this date | ||||
| availabilityExceptions |
0..1 | string | Description of availability exceptions | |||||
| endpoint |
SC | 0..* | Reference(Plan-Net Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| PractitionerRole.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| PractitionerRole.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| PractitionerRole.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| PractitionerRole.extension:qualification.extension:code.value[x] | extensible | IndividualSpecialtyAndDegreeLicenseCertificateVShttp://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/IndividualSpecialtyAndDegreeLicenseCertificateVSfrom this IG | ||||
| PractitionerRole.extension:qualification.extension:status.value[x] | required | Fixed Value: activehttp://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/QualificationStatusVSfrom this IG | ||||
| PractitionerRole.extension:qualification.extension:whereValid.value[x] | required | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state | ||||
| PractitionerRole.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| PractitionerRole.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| PractitionerRole.code | required | PractitionerRoleVShttp://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/PractitionerRoleVSfrom this IG | ||||
| PractitionerRole.specialty | required | IndividualAndGroupSpecialtiesVShttp://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/IndividualAndGroupSpecialtiesVSfrom this IG | ||||
| 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 |
| practitioner-or-organization-or-healthcareservice-or-location | error | PractitionerRole | If PlannetPractitionerRole.practitioner is absent ( PlannetPractitionerRole.organization, PlannetPractitionerRole.healthcareservice, PlannetPractitionerRole.location) must be present : practitioner.exists() or (organization.exists() or healthcareService.exists() or location.exists()) |
This structure is derived from USCorePractitionerRoleProfile
Summary
Mandatory: 1 element(1 nested mandatory element)
Must-Support: 19 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / Financial Management. Package hl7.fhir.us.davinci-pdex-plan-net#1.2.0 based on FHIR 4.0.1. Generated 2024-12-17
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change