careMESH NPD
0.1.0 - ci-build
careMESH NPD
0.1.0 - ci-build
careMESH NPD - Local Development build (v0.1.0). See the Directory of published versions
| Official URL: http://fhir.caremesh.app/StructureDefinition/caremesh-PractitionerRole | Version: 0.1.0 | |||
| Active as of 2023-12-07 | Computable Name: CaremeshPractitionerRole | |||
A careMESH PractionerRole describes details about a provider, which can be a practitioner or an organization. When the provider is a practitioner, there may be a relationship to an organization.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PlannetPractitionerRole
| Path | Conformance | ValueSet |
| PractitionerRole.specialty | required | CaremeshSpecialtiesVS |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  PractitionerRole | C | 0..* | PlannetPractitionerRole | Roles/organizations the practitioner is associated with |
  implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 newpatients | SC | 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 | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
 extension:identifier | S | 0..* | Extension | Extension |
 extension | 0..0 | |||
| url | 1..1 | uri | "identifier" | |
  value[x] | 1..1 | Identifier | Value of extension | |
| extension:code | S | 1..1 | Extension | Extension |
| 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 |
| 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 |
| extension | 0..0 | |||
| url | 1..1 | uri | "status" | |
  Slices for value[x] | 1..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
  value[x]:valueCode | 1..1 | code | Value of extension Binding: Qualification Status VS (required) Fixed Value: active | |
| extension:period | S | 0..1 | Extension | Extension |
| extension | 0..0 | |||
| url | 1..1 | uri | "period" | |
| value[x] | 1..1 | Period | Value of extension | |
| extension:whereValid | S | 0..* | Extension | Extension |
| 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" | |
| primaryDesignator | 0..* | CodeableConcept | careMESH Primary Designator URL: http://fhir.caremesh.app/StructureDefinition/caremesh-primary-designator | |
| customDesignation | 0..* | CodeableConcept | careMESH Custom Designation URL: http://fhir.caremesh.app/StructureDefinition/caremesh-custom-designation Binding: careMESH Custom Designation (required) | |
| programParticipation | 0..* | (Complex) | careMESH Program Participation URL: http://fhir.caremesh.app/StructureDefinition/caremesh-program-participation | |
| title | 0..* | CodeableConcept | careMESH PractitionerRoleTitle URL: http://fhir.caremesh.app/StructureDefinition/caremesh-practitioner-role-title Binding: careMESH Practitioner Role Title Valueset (required) | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location |
| 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. |
| value | SΣ | 0..1 | string | The value that is unique Example General: 123456 |
| 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Σ | 1..1 | Reference(Plan-Net Practitioner) | Practitioner that is able to provide the defined services for the organization |
| organization | SΣ | 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: Caremesh Specialties VS (required) |
| location | SΣ | 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 | SΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
| 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 |
| telecom-info | S | 0..1 | (Complex) | careMESH ContactPoint Description URL: http://fhir.caremesh.app/StructureDefinition/caremesh-contact-point-description |
| 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) |
| availableTime | S | 0..* | BackboneElement | Times the Service Site is available |
| 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 |
| 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 |
| endpoint | S | 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 |
| PractitionerRole.extension:qualification.extension:code.value[x] | extensible | IndividualSpecialtyAndDegreeLicenseCertificateVS |
| PractitionerRole.extension:qualification.extension:status.value[x]:valueCode | required | Fixed Value: active |
| PractitionerRole.extension:qualification.extension:whereValid.value[x] | required | UspsTwoLetterAlphabeticCodes |
| PractitionerRole.identifier.use | required | IdentifierUse |
| PractitionerRole.identifier.type | extensible | Identifier Type Codes |
| PractitionerRole.code | required | PractitionerRoleVS |
| PractitionerRole.specialty | required | CaremeshSpecialtiesVS |
| PractitionerRole.telecom.system | required | ContactPointSystem |
| PractitionerRole.telecom.use | required | ContactPointUse |
| PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeek |
| 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() | |
| new-patients-characteristics | error | PractitionerRole.extension:newpatients | If no new patients are accepted, no characteristics are allowed : extension('acceptingPatients').valueCodeableConcept.coding.exists(code = 'no') implies extension('characteristics').empty() | |
| 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..* | PlannetPractitionerRole | Roles/organizations the practitioner is associated with | ||||
| 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 | ||||
| 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" | |||||
| Slices for value[x] | 1..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueCode | 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" | |||||
| primaryDesignator | 0..* | CodeableConcept | careMESH Primary Designator URL: http://fhir.caremesh.app/StructureDefinition/caremesh-primary-designator | |||||
| customDesignation | 0..* | CodeableConcept | careMESH Custom Designation URL: http://fhir.caremesh.app/StructureDefinition/caremesh-custom-designation Binding: careMESH Custom Designation (required) | |||||
| programParticipation | 0..* | (Complex) | careMESH Program Participation URL: http://fhir.caremesh.app/StructureDefinition/caremesh-program-participation | |||||
| title | 0..* | CodeableConcept | careMESH PractitionerRoleTitle URL: http://fhir.caremesh.app/StructureDefinition/caremesh-practitioner-role-title Binding: careMESH Practitioner Role Title Valueset (required) | |||||
| 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Σ | 1..1 | Reference(Plan-Net Practitioner) | Practitioner that is able to provide the defined services for the organization | ||||
| organization | SΣ | 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: Caremesh Specialties VS (required) | ||||
| location | SΣ | 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 | SΣ | 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 | ||||
| telecom-info | S | 0..1 | (Complex) | careMESH ContactPoint Description URL: http://fhir.caremesh.app/StructureDefinition/caremesh-contact-point-description | ||||
| 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 | S | 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 | ||||
| PractitionerRole.meta.security | extensible | All Security Labels | ||||
| PractitionerRole.meta.tag | example | CommonTags | ||||
| PractitionerRole.language | preferred | CommonLanguages
| ||||
| PractitionerRole.extension:qualification.extension:code.value[x] | extensible | IndividualSpecialtyAndDegreeLicenseCertificateVS | ||||
| PractitionerRole.extension:qualification.extension:status.value[x]:valueCode | required | Fixed Value: active | ||||
| PractitionerRole.extension:qualification.extension:whereValid.value[x] | required | UspsTwoLetterAlphabeticCodes | ||||
| PractitionerRole.identifier.use | required | IdentifierUse | ||||
| PractitionerRole.identifier.type | extensible | Identifier Type Codes | ||||
| PractitionerRole.code | required | PractitionerRoleVS | ||||
| PractitionerRole.specialty | required | CaremeshSpecialtiesVS | ||||
| PractitionerRole.telecom.system | required | ContactPointSystem | ||||
| PractitionerRole.telecom.use | required | ContactPointUse | ||||
| PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeek |
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| new-patients-characteristics | error | PractitionerRole.extension:newpatients | If no new patients are accepted, no characteristics are allowed : extension('acceptingPatients').valueCodeableConcept.coding.exists(code = 'no') implies extension('characteristics').empty() |
This structure is derived from PlannetPractitionerRole
Summary
Mandatory: 1 element
Must-Support: 1 element
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from PlannetPractitionerRole
| Path | Conformance | ValueSet |
| PractitionerRole.specialty | required | CaremeshSpecialtiesVS |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole | C | 0..* | PlannetPractitionerRole | Roles/organizations the practitioner is associated with |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| newpatients | SC | 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 | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:identifier | S | 0..* | Extension | Extension |
| extension | 0..0 | |||
| url | 1..1 | uri | "identifier" | |
| value[x] | 1..1 | Identifier | Value of extension | |
| extension:code | S | 1..1 | Extension | Extension |
| 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 |
| 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 |
| extension | 0..0 | |||
| url | 1..1 | uri | "status" | |
| Slices for value[x] | 1..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCode | 1..1 | code | Value of extension Binding: Qualification Status VS (required) Fixed Value: active | |
| extension:period | S | 0..1 | Extension | Extension |
| extension | 0..0 | |||
| url | 1..1 | uri | "period" | |
| value[x] | 1..1 | Period | Value of extension | |
| extension:whereValid | S | 0..* | Extension | Extension |
| 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" | |
| primaryDesignator | 0..* | CodeableConcept | careMESH Primary Designator URL: http://fhir.caremesh.app/StructureDefinition/caremesh-primary-designator | |
| customDesignation | 0..* | CodeableConcept | careMESH Custom Designation URL: http://fhir.caremesh.app/StructureDefinition/caremesh-custom-designation Binding: careMESH Custom Designation (required) | |
| programParticipation | 0..* | (Complex) | careMESH Program Participation URL: http://fhir.caremesh.app/StructureDefinition/caremesh-program-participation | |
| title | 0..* | CodeableConcept | careMESH PractitionerRoleTitle URL: http://fhir.caremesh.app/StructureDefinition/caremesh-practitioner-role-title Binding: careMESH Practitioner Role Title Valueset (required) | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location |
| 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. |
| value | SΣ | 0..1 | string | The value that is unique Example General: 123456 |
| 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Σ | 1..1 | Reference(Plan-Net Practitioner) | Practitioner that is able to provide the defined services for the organization |
| organization | SΣ | 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: Caremesh Specialties VS (required) |
| location | SΣ | 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 | SΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
| 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 |
| telecom-info | S | 0..1 | (Complex) | careMESH ContactPoint Description URL: http://fhir.caremesh.app/StructureDefinition/caremesh-contact-point-description |
| 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) |
| availableTime | S | 0..* | BackboneElement | Times the Service Site is available |
| 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 |
| 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 |
| endpoint | S | 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 |
| PractitionerRole.extension:qualification.extension:code.value[x] | extensible | IndividualSpecialtyAndDegreeLicenseCertificateVS |
| PractitionerRole.extension:qualification.extension:status.value[x]:valueCode | required | Fixed Value: active |
| PractitionerRole.extension:qualification.extension:whereValid.value[x] | required | UspsTwoLetterAlphabeticCodes |
| PractitionerRole.identifier.use | required | IdentifierUse |
| PractitionerRole.identifier.type | extensible | Identifier Type Codes |
| PractitionerRole.code | required | PractitionerRoleVS |
| PractitionerRole.specialty | required | CaremeshSpecialtiesVS |
| PractitionerRole.telecom.system | required | ContactPointSystem |
| PractitionerRole.telecom.use | required | ContactPointUse |
| PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeek |
| 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() | |
| new-patients-characteristics | error | PractitionerRole.extension:newpatients | If no new patients are accepted, no characteristics are allowed : extension('acceptingPatients').valueCodeableConcept.coding.exists(code = 'no') implies extension('characteristics').empty() | |
| 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..* | PlannetPractitionerRole | Roles/organizations the practitioner is associated with | ||||
| 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 | ||||
| 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" | |||||
| Slices for value[x] | 1..1 | code | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueCode | 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" | |||||
| primaryDesignator | 0..* | CodeableConcept | careMESH Primary Designator URL: http://fhir.caremesh.app/StructureDefinition/caremesh-primary-designator | |||||
| customDesignation | 0..* | CodeableConcept | careMESH Custom Designation URL: http://fhir.caremesh.app/StructureDefinition/caremesh-custom-designation Binding: careMESH Custom Designation (required) | |||||
| programParticipation | 0..* | (Complex) | careMESH Program Participation URL: http://fhir.caremesh.app/StructureDefinition/caremesh-program-participation | |||||
| title | 0..* | CodeableConcept | careMESH PractitionerRoleTitle URL: http://fhir.caremesh.app/StructureDefinition/caremesh-practitioner-role-title Binding: careMESH Practitioner Role Title Valueset (required) | |||||
| 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Σ | 1..1 | Reference(Plan-Net Practitioner) | Practitioner that is able to provide the defined services for the organization | ||||
| organization | SΣ | 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: Caremesh Specialties VS (required) | ||||
| location | SΣ | 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 | SΣ | 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 | ||||
| telecom-info | S | 0..1 | (Complex) | careMESH ContactPoint Description URL: http://fhir.caremesh.app/StructureDefinition/caremesh-contact-point-description | ||||
| 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 | S | 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 | ||||
| PractitionerRole.meta.security | extensible | All Security Labels | ||||
| PractitionerRole.meta.tag | example | CommonTags | ||||
| PractitionerRole.language | preferred | CommonLanguages
| ||||
| PractitionerRole.extension:qualification.extension:code.value[x] | extensible | IndividualSpecialtyAndDegreeLicenseCertificateVS | ||||
| PractitionerRole.extension:qualification.extension:status.value[x]:valueCode | required | Fixed Value: active | ||||
| PractitionerRole.extension:qualification.extension:whereValid.value[x] | required | UspsTwoLetterAlphabeticCodes | ||||
| PractitionerRole.identifier.use | required | IdentifierUse | ||||
| PractitionerRole.identifier.type | extensible | Identifier Type Codes | ||||
| PractitionerRole.code | required | PractitionerRoleVS | ||||
| PractitionerRole.specialty | required | CaremeshSpecialtiesVS | ||||
| PractitionerRole.telecom.system | required | ContactPointSystem | ||||
| PractitionerRole.telecom.use | required | ContactPointUse | ||||
| PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeek |
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| new-patients-characteristics | error | PractitionerRole.extension:newpatients | If no new patients are accepted, no characteristics are allowed : extension('acceptingPatients').valueCodeableConcept.coding.exists(code = 'no') implies extension('characteristics').empty() |
This structure is derived from PlannetPractitionerRole
Summary
Mandatory: 1 element
Must-Support: 1 element
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
