Data Model Libraries
    Preparing search index...

    Class Practitioner

    Practitioner Class

    A person who is directly or indirectly involved in the provisioning of healthcare or related services.

    Need to track doctors, staff, locums etc. for both healthcare practitioners, funders, etc.

    FHIR Specification

    • Short: A person with a formal responsibility in the provisioning of healthcare or related services
    • Definition: A person who is directly or indirectly involved in the provisioning of healthcare or related services.
    • FHIR Version: 5.0.0

    FHIR Practitioner

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? active? name? telecom? administrativeGenderEnum gender? birthDate? deceased? address? photo? qualification? communication?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getActiveElement setActiveElement hasActiveElement getActive setActive hasActive getName setName addName hasName getTelecom setTelecom addTelecom hasTelecom getGenderEnumType setGenderEnumType hasGenderEnumType getGenderElement setGenderElement hasGenderElement getGender setGender hasGender getBirthDateElement setBirthDateElement hasBirthDateElement getBirthDate setBirthDate hasBirthDate getDeceased setDeceased hasDeceased getDeceasedBooleanType hasDeceasedBooleanType getDeceasedDateTimeType hasDeceasedDateTimeType getAddress setAddress addAddress hasAddress getPhoto setPhoto addPhoto hasPhoto getQualification setQualification addQualification hasQualification getCommunication setCommunication addCommunication hasCommunication 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 initName initTelecom initAddress initPhoto initQualification initCommunication

    Constructors

    Properties

    identifier?: Identifier[]

    Practitioner.identifier Element

    FHIR Specification

    • Short: An identifier for the person as this agent
    • Definition: An identifier that applies to this person in this role.
    • Requirements: Often, specific identities are assigned for the agent.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    active?: BooleanType

    Practitioner.active Element

    FHIR Specification

    • Short: Whether this practitioner's record is in active use
    • Definition: Whether this practitioner's record is in active use.
    • Comment: If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.
    • Requirements: Need to be able to mark a practitioner record as not to be used because it was created in error.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
    • isSummary: true
    name?: HumanName[]

    Practitioner.name Element

    FHIR Specification

    • Short: The name(s) associated with the practitioner
    • Definition: The name(s) associated with the practitioner.
    • Comment: The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this: 1. There is more than 1 name 2. Use = usual 3. Period is current to the date of the usage 4. Use = official 5. Other order as decided by internal business rules.
    • Requirements: The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.
    • FHIR Type: HumanName
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    telecom?: ContactPoint[]

    Practitioner.telecom Element

    FHIR Specification

    • Short: A contact detail for the practitioner (that apply to all roles)
    • Definition: A contact detail for the practitioner, e.g. a telephone number or an email address.
    • Comment: Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.
    • Requirements: Need to know how to reach a practitioner independent to any roles the practitioner may have.
    • FHIR Type: ContactPoint
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    administrativeGenderEnum: AdministrativeGenderEnum

    FHIR CodeSystem: AdministrativeGender

    AdministrativeGenderEnum

    gender?: EnumCodeType

    Practitioner.gender Element

    FHIR Specification

    • Short: male | female | other | unknown
    • Definition: Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
    • Requirements: Needed to address the person correctly.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: AdministrativeGenderEnum

    birthDate?: DateType

    Practitioner.birthDate Element

    FHIR Specification

    • Short: The date on which the practitioner was born
    • Definition: The date of birth for the practitioner.
    • Requirements: Needed for identification.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    deceased?: IDataType

    Practitioner.deceased[x] Element

    @ChoiceDataTypesMeta('Practitioner.deceased[x]', ['boolean','dateTime',]

    FHIR Specification

    • Short: Indicates if the practitioner is deceased or not
    • Definition: Indicates if the practitioner is deceased or not.
    • Comment: If there's no value in the instance, it means there is no statement on whether or not the practitioner is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.
    • FHIR Types: 'boolean', 'dateTime',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    address?: Address[]

    Practitioner.address Element

    FHIR Specification

    • Short: Address(es) of the practitioner that are not role specific (typically home address)
    • Definition: Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.
    • Comment: The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).
    • Requirements: The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations.
    • FHIR Type: Address
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    photo?: Attachment[]

    Practitioner.photo Element

    FHIR Specification

    • Short: Image of the person
    • Definition: Image of the person.
    • Requirements: Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.
    • FHIR Type: Attachment
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    qualification?: PractitionerQualificationComponent[]

    Practitioner.qualification Element

    FHIR Specification

    • Short: Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care
    • Definition: The official qualifications, certifications, accreditations, training, licenses (and other types of educations/skills/capabilities) that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board of licensure authorizing the practitioner to practice medicine within a certain locality.
    • Comment: The PractitionerRole.specialty defines the functional role that they are practicing at a given organization or location. Those specialties may or might not require a qualification, and are not defined on the practitioner.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    communication?: PractitionerCommunicationComponent[]

    Practitioner.communication Element

    FHIR Specification

    • Short: A language which may be used to communicate with the practitioner
    • Definition: A language which may be used to communicate with the practitioner, often for correspondence/administrative purposes. The PractitionerRole.communication property should be used for publishing the languages that a practitioner is able to communicate with patients (on a per Organization/Role basis).
    • Comment: If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Practitioner.Communication associations. For animals, language is not a relevant field, and should be absent from the instance.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR Practitioner

      • OptionaloptSourceField: string

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

      Returns undefined | Practitioner

      Practitioner data model or undefined for Practitioner

      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
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetActiveElementsetActiveElementhasActiveElementgetActivesetActivehasActivegetNamesetNameaddNamehasNamegetTelecomsetTelecomaddTelecomhasTelecomgetGenderEnumTypesetGenderEnumTypehasGenderEnumTypegetGenderElementsetGenderElementhasGenderElementgetGendersetGenderhasGendergetBirthDateElementsetBirthDateElementhasBirthDateElementgetBirthDatesetBirthDatehasBirthDategetDeceasedsetDeceasedhasDeceasedgetDeceasedBooleanTypehasDeceasedBooleanTypegetDeceasedDateTimeTypehasDeceasedDateTimeTypegetAddresssetAddressaddAddresshasAddressgetPhotosetPhotoaddPhotohasPhotogetQualificationsetQualificationaddQualificationhasQualificationgetCommunicationsetCommunicationaddCommunicationhasCommunicationfhirTypeisEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisRequiredFieldsEmptyisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitNameinitTelecominitAddressinitPhotoinitQualificationinitCommunication