Data Model Libraries
    Preparing search index...

    Class PractitionerRole

    PractitionerRole Class

    A specific set of Roles/Locations/specialties/services that a practitioner may perform, or has performed at an organization during a period of time.

    Need to track services that a healthcare provider is able to provide at an organization's location, and the services that they can perform there.

    FHIR Specification

    • Short: Roles/organizations the practitioner is associated with
    • Definition: A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
    • FHIR Version: 5.0.0

    FHIR PractitionerRole

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? active? period? practitioner? organization? code? specialty? location? healthcareService? contact? characteristic? communication? availability? endpoint?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getActiveElement setActiveElement hasActiveElement getActive setActive hasActive getPeriod setPeriod hasPeriod getPractitioner setPractitioner hasPractitioner getOrganization setOrganization hasOrganization getCode setCode addCode hasCode getSpecialty setSpecialty addSpecialty hasSpecialty getLocation setLocation addLocation hasLocation getHealthcareService setHealthcareService addHealthcareService hasHealthcareService getContact setContact addContact hasContact getCharacteristic setCharacteristic addCharacteristic hasCharacteristic getCommunication setCommunication addCommunication hasCommunication getAvailability setAvailability addAvailability hasAvailability getEndpoint setEndpoint addEndpoint hasEndpoint fhirType isEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isRequiredFieldsEmpty isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initCode initSpecialty initLocation initHealthcareService initContact initCharacteristic initCommunication initAvailability initEndpoint

    Constructors

    Properties

    identifier?: Identifier[]

    PractitionerRole.identifier Element

    FHIR Specification

    • Short: Identifiers for a role/location
    • Definition: Business Identifiers that are specific to a role/location.
    • Comment: A specific identifier value (e.g. Minnesota Registration ID) may appear on multiple PractitionerRole instances which could be for different periods, or different Roles (or other reasons). A specific identifier may be included multiple times in the same PractitionerRole instance with different identifier validity periods.
    • Requirements: Often, specific identities are assigned for the agent.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    active?: BooleanType

    PractitionerRole.active Element

    FHIR Specification

    • Short: Whether this practitioner role record is in active use
    • Definition: Whether this practitioner role record is in active use. Some systems may use this property to mark non-active practitioners, such as those that are not currently employed.
    • Comment: If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.
    • Requirements: Need to be able to mark a practitioner role record as not to be used because it was created in error, or otherwise no longer in active use.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    period?: Period

    PractitionerRole.period Element

    FHIR Specification

    • Short: The period during which the practitioner is authorized to perform in these role(s)
    • Definition: The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
    • Comment: If a practitioner is performing a role within an organization over multiple, non-adjacent periods, there should be a distinct PractitionerRole instance for each period. For example, if a nurse is employed at a hospital, leaves the organization for a period of time due to pandemic related stress, but returns post-pandemic to the same job role, there would be two PractitionerRole instances for the different periods of employment.
    • Requirements: Even after the agencies is revoked, the fact that it existed must still be recorded.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    practitioner?: Reference

    PractitionerRole.practitioner Element

    FHIR Specification

    • Short: Practitioner that provides services for the organization
    • Definition: Practitioner that is able to provide the defined services for the organization.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    organization?: Reference

    PractitionerRole.organization Element

    FHIR Specification

    • Short: Organization where the roles are available
    • Definition: The organization where the Practitioner performs the roles associated.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    code?: CodeableConcept[]

    PractitionerRole.code Element

    FHIR Specification

    • Short: Roles which this practitioner may perform
    • Definition: Roles which this practitioner is authorized to perform for the organization.
    • Comment: A person may have more than one role.
    • Requirements: Need to know what authority the practitioner has - what can they do?
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    specialty?: CodeableConcept[]

    PractitionerRole.specialty Element

    FHIR Specification

    • Short: Specific specialty of the practitioner
    • Definition: The specialty of a practitioner that describes the functional role they are practicing at a given organization or location.
    • Comment: The specialty represents the functional role a practitioner is playing within an organization/location. This role may require the individual have certain qualifications, which would be represented in the Practitioner.qualifications property. Note that qualifications may or might not relate to or be required by the practicing specialty.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    location?: Reference[]

    PractitionerRole.location Element

    FHIR Specification

    • Short: Location(s) where the practitioner provides care
    • Definition: The location(s) at which this practitioner provides care.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    healthcareService?: Reference[]

    PractitionerRole.healthcareService Element

    FHIR Specification

    • Short: Healthcare services provided for this role's Organization/Location(s)
    • Definition: The list of healthcare services that this worker provides for this role's Organization/Location(s).
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    contact?: ExtendedContactDetail[]

    PractitionerRole.contact Element

    FHIR Specification

    • Short: Official contact details relating to this PractitionerRole
    • Definition: The contact details of communication devices available relevant to the specific PractitionerRole. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.
    • Requirements: Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these. Sometimes these also include a named person/organization that handles contact for specific purposes, such as a receptionist, or accounts clerk etc.
    • FHIR Type: ExtendedContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    characteristic?: CodeableConcept[]

    PractitionerRole.characteristic Element

    FHIR Specification

    • Short: Collection of characteristics (attributes)
    • Definition: Collection of characteristics (attributes).
    • Comment: These could be such things as is the service mode used by this role.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    communication?: CodeableConcept[]

    PractitionerRole.communication Element

    FHIR Specification

    • Short: A language the practitioner (in this role) can use in patient communication
    • Definition: A language the practitioner can use in patient communication. The practitioner may know several languages (listed in practitioner.communication), however these are the languages that could be advertised in a directory for a patient to search.
    • Comment: The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. Note that for non-patient oriented communication, see Practitioner.communication. Note that all 'person' type resources (Person, RelatedPerson, Patient, Practitioner) have a communication structure that includes preferences. Role or service oriented resources such as HealthcareService and PractitionerRole only include languages that are available for interacting with patients.
    • Requirements: Knowing which language a practitioner speaks can help in facilitating patients to locate practitioners that speak their language.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    availability?: Availability[]

    PractitionerRole.availability Element

    FHIR Specification

    • Short: Times the Practitioner is available at this location and/or healthcare service (including exceptions)
    • Definition: A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
    • Comment: More detailed availability information may be provided in associated Schedule/Slot resources. Systems may choose to render availability differently than it is exchanged on the interface. For example, rather than "Mon, Tue, Wed, Thur, Fri from 9am-12am; Mon, Tue, Wed, Thur, Fri from 1pm-5pm" as would be implied by two availableTime repetitions, an application could render this information as "Mon-Fri 9-12am and 1-5pm". The NotAvailableTime(s) included indicate the general days/periods where the practitioner is not available (for things such as vacation time, or public holidays).
    • FHIR Type: Availability
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    endpoint?: Reference[]

    PractitionerRole.endpoint Element

    FHIR Specification

    • Short: Endpoints for interacting with the practitioner in this role
    • Definition: Technical endpoints providing access to services operated for the practitioner with this role. Commonly used for locating scheduling services, or identifying where to send referrals electronically.
    • Requirements: Organizations have multiple systems that provide various services and may also be different for practitioners too. So the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided PractitionerRole JSON to instantiate the PractitionerRole data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR PractitionerRole

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to PractitionerRole

      Returns undefined | PractitionerRole

      PractitionerRole data model or undefined for PractitionerRole

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetActiveElementsetActiveElementhasActiveElementgetActivesetActivehasActivegetPeriodsetPeriodhasPeriodgetPractitionersetPractitionerhasPractitionergetOrganizationsetOrganizationhasOrganizationgetCodesetCodeaddCodehasCodegetSpecialtysetSpecialtyaddSpecialtyhasSpecialtygetLocationsetLocationaddLocationhasLocationgetHealthcareServicesetHealthcareServiceaddHealthcareServicehasHealthcareServicegetContactsetContactaddContacthasContactgetCharacteristicsetCharacteristicaddCharacteristichasCharacteristicgetCommunicationsetCommunicationaddCommunicationhasCommunicationgetAvailabilitysetAvailabilityaddAvailabilityhasAvailabilitygetEndpointsetEndpointaddEndpointhasEndpointfhirTypeisEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisRequiredFieldsEmptyisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitCodeinitSpecialtyinitLocationinitHealthcareServiceinitContactinitCharacteristicinitCommunicationinitAvailabilityinitEndpoint