Package ca.uhn.fhir.model.dstu2.resource

Class Practitioner

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource
    public class Practitioner
extends BaseResource
implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR Practitioner Resource (administrative.individual)

    Definition: A person who is directly or indirectly involved in the provisioning of healthcare.

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

    Profile Definition: http://hl7.org/fhir/profiles/Practitioner

    See Also:
    Serialized Form

    • Field Detail

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter constant for identifier

        Description: A practitioner's Identifier
        Type: token
        Path: Practitioner.identifier

        See Also:
        Constant Field Values

      • IDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
        Fluent Client search parameter constant for identifier

        Description: A practitioner's Identifier
        Type: token
        Path: Practitioner.identifier

      • SP_NAME

        public static final String SP_NAME
        Search parameter constant for name

        Description: A portion of either family or given name
        Type: string
        Path: Practitioner.name

        See Also:
        Constant Field Values

      • NAME

        public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
        Fluent Client search parameter constant for name

        Description: A portion of either family or given name
        Type: string
        Path: Practitioner.name

      • SP_FAMILY

        public static final String SP_FAMILY
        Search parameter constant for family

        Description: A portion of the family name
        Type: string
        Path: Practitioner.name.family

        See Also:
        Constant Field Values

      • FAMILY

        public static final ca.uhn.fhir.rest.gclient.StringClientParam FAMILY
        Fluent Client search parameter constant for family

        Description: A portion of the family name
        Type: string
        Path: Practitioner.name.family

      • SP_GIVEN

        public static final String SP_GIVEN
        Search parameter constant for given

        Description: A portion of the given name
        Type: string
        Path: Practitioner.name.given

        See Also:
        Constant Field Values

      • GIVEN

        public static final ca.uhn.fhir.rest.gclient.StringClientParam GIVEN
        Fluent Client search parameter constant for given

        Description: A portion of the given name
        Type: string
        Path: Practitioner.name.given

      • SP_PHONETIC

        public static final String SP_PHONETIC
        Search parameter constant for phonetic

        Description: A portion of either family or given name using some kind of phonetic matching algorithm
        Type: string
        Path: Practitioner.name

        See Also:
        Constant Field Values

      • PHONETIC

        public static final ca.uhn.fhir.rest.gclient.StringClientParam PHONETIC
        Fluent Client search parameter constant for phonetic

        Description: A portion of either family or given name using some kind of phonetic matching algorithm
        Type: string
        Path: Practitioner.name

      • SP_TELECOM

        public static final String SP_TELECOM
        Search parameter constant for telecom

        Description: The value in any kind of contact
        Type: token
        Path: Practitioner.telecom

        See Also:
        Constant Field Values

      • TELECOM

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam TELECOM
        Fluent Client search parameter constant for telecom

        Description: The value in any kind of contact
        Type: token
        Path: Practitioner.telecom

      • SP_PHONE

        public static final String SP_PHONE
        Search parameter constant for phone

        Description: A value in a phone contact
        Type: token
        Path: Practitioner.telecom(system=phone)

        See Also:
        Constant Field Values

      • PHONE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam PHONE
        Fluent Client search parameter constant for phone

        Description: A value in a phone contact
        Type: token
        Path: Practitioner.telecom(system=phone)

      • SP_EMAIL

        public static final String SP_EMAIL
        Search parameter constant for email

        Description: A value in an email contact
        Type: token
        Path: Practitioner.telecom(system=email)

        See Also:
        Constant Field Values

      • EMAIL

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam EMAIL
        Fluent Client search parameter constant for email

        Description: A value in an email contact
        Type: token
        Path: Practitioner.telecom(system=email)

      • SP_ADDRESS

        public static final String SP_ADDRESS
        Search parameter constant for address

        Description: An address in any kind of address/part
        Type: string
        Path: Practitioner.address

        See Also:
        Constant Field Values

      • ADDRESS

        public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS
        Fluent Client search parameter constant for address

        Description: An address in any kind of address/part
        Type: string
        Path: Practitioner.address

      • SP_ADDRESS_CITY

        public static final String SP_ADDRESS_CITY
        Search parameter constant for address-city

        Description: A city specified in an address
        Type: string
        Path: Practitioner.address.city

        See Also:
        Constant Field Values

      • ADDRESS_CITY

        public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_CITY
        Fluent Client search parameter constant for address-city

        Description: A city specified in an address
        Type: string
        Path: Practitioner.address.city

      • SP_ADDRESS_STATE

        public static final String SP_ADDRESS_STATE
        Search parameter constant for address-state

        Description: A state specified in an address
        Type: string
        Path: Practitioner.address.state

        See Also:
        Constant Field Values

      • ADDRESS_STATE

        public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_STATE
        Fluent Client search parameter constant for address-state

        Description: A state specified in an address
        Type: string
        Path: Practitioner.address.state

      • SP_ADDRESS_POSTALCODE

        public static final String SP_ADDRESS_POSTALCODE
        Search parameter constant for address-postalcode

        Description: A postalCode specified in an address
        Type: string
        Path: Practitioner.address.postalCode

        See Also:
        Constant Field Values

      • ADDRESS_POSTALCODE

        public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_POSTALCODE
        Fluent Client search parameter constant for address-postalcode

        Description: A postalCode specified in an address
        Type: string
        Path: Practitioner.address.postalCode

      • SP_ADDRESS_COUNTRY

        public static final String SP_ADDRESS_COUNTRY
        Search parameter constant for address-country

        Description: A country specified in an address
        Type: string
        Path: Practitioner.address.country

        See Also:
        Constant Field Values

      • ADDRESS_COUNTRY

        public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_COUNTRY
        Fluent Client search parameter constant for address-country

        Description: A country specified in an address
        Type: string
        Path: Practitioner.address.country

      • SP_ADDRESS_USE

        public static final String SP_ADDRESS_USE
        Search parameter constant for address-use

        Description: A use code specified in an address
        Type: token
        Path: Practitioner.address.use

        See Also:
        Constant Field Values

      • ADDRESS_USE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam ADDRESS_USE
        Fluent Client search parameter constant for address-use

        Description: A use code specified in an address
        Type: token
        Path: Practitioner.address.use

      • SP_GENDER

        public static final String SP_GENDER
        Search parameter constant for gender

        Description: Gender of the practitioner
        Type: token
        Path: Practitioner.gender

        See Also:
        Constant Field Values

      • GENDER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam GENDER
        Fluent Client search parameter constant for gender

        Description: Gender of the practitioner
        Type: token
        Path: Practitioner.gender

      • SP_ORGANIZATION

        public static final String SP_ORGANIZATION
        Search parameter constant for organization

        Description: The identity of the organization the practitioner represents / acts on behalf of
        Type: reference
        Path: Practitioner.practitionerRole.managingOrganization

        See Also:
        Constant Field Values

      • ORGANIZATION

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ORGANIZATION
        Fluent Client search parameter constant for organization

        Description: The identity of the organization the practitioner represents / acts on behalf of
        Type: reference
        Path: Practitioner.practitionerRole.managingOrganization

      • SP_COMMUNICATION

        public static final String SP_COMMUNICATION
        Search parameter constant for communication

        Description: One of the languages that the practitioner can communicate with
        Type: token
        Path: Practitioner.communication

        See Also:
        Constant Field Values

      • COMMUNICATION

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam COMMUNICATION
        Fluent Client search parameter constant for communication

        Description: One of the languages that the practitioner can communicate with
        Type: token
        Path: Practitioner.communication

      • SP_LOCATION

        public static final String SP_LOCATION
        Search parameter constant for location

        Description: One of the locations at which this practitioner provides care
        Type: reference
        Path: Practitioner.practitionerRole.location

        See Also:
        Constant Field Values

      • LOCATION

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam LOCATION
        Fluent Client search parameter constant for location

        Description: One of the locations at which this practitioner provides care
        Type: reference
        Path: Practitioner.practitionerRole.location

      • SP_SPECIALTY

        public static final String SP_SPECIALTY
        Search parameter constant for specialty

        Description: The practitioner has this specialty at an organization
        Type: token
        Path: Practitioner.practitionerRole.specialty

        See Also:
        Constant Field Values

      • SPECIALTY

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam SPECIALTY
        Fluent Client search parameter constant for specialty

        Description: The practitioner has this specialty at an organization
        Type: token
        Path: Practitioner.practitionerRole.specialty

      • SP_ROLE

        public static final String SP_ROLE
        Search parameter constant for role

        Description: The practitioner can perform this role at for the organization
        Type: token
        Path: Practitioner.practitionerRole.role

        See Also:
        Constant Field Values

      • ROLE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam ROLE
        Fluent Client search parameter constant for role

        Description: The practitioner can perform this role at for the organization
        Type: token
        Path: Practitioner.practitionerRole.role

      • INCLUDE_LOCATION

        public static final ca.uhn.fhir.model.api.Include INCLUDE_LOCATION
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Practitioner:location".

      • INCLUDE_ORGANIZATION

        public static final ca.uhn.fhir.model.api.Include INCLUDE_ORGANIZATION
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Practitioner:organization".

    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase

      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement

      • getIdentifier

        public List<IdentifierDt> getIdentifier()
        Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.

        Definition: An identifier that applies to this person in this role

      • addIdentifier

        public IdentifierDt addIdentifier()
        Adds and returns a new value for identifier (id)

        Definition: An identifier that applies to this person in this role

      • addIdentifier

        public Practitioner addIdentifier​(IdentifierDt theValue)
        Adds a given new value for identifier (id)

        Definition: An identifier that applies to this person in this role

        Parameters:
        theValue - The identifier to add (must not be null)

      • getIdentifierFirstRep

        public IdentifierDt getIdentifierFirstRep()
        Gets the first repetition for identifier (id), creating it if it does not already exist.

        Definition: An identifier that applies to this person in this role

      • getActiveElement

        public ca.uhn.fhir.model.primitive.BooleanDt getActiveElement()
        Gets the value(s) for active (status). creating it if it does not exist. Will not return null.

        Definition: Whether this practitioner's record is in active use

      • getActive

        public Boolean getActive()
        Gets the value(s) for active (status). creating it if it does not exist. This method may return null.

        Definition: Whether this practitioner's record is in active use

      • setActive

        public Practitioner setActive​(ca.uhn.fhir.model.primitive.BooleanDt theValue)
        Sets the value(s) for active (status)

        Definition: Whether this practitioner's record is in active use

      • setActive

        public Practitioner setActive​(boolean theBoolean)
        Sets the value for active (status)

        Definition: Whether this practitioner's record is in active use

      • getName

        public HumanNameDt getName()
        Gets the value(s) for name (). creating it if it does not exist. Will not return null.

        Definition: A name associated with the person

      • getTelecom

        public List<ContactPointDt> getTelecom()
        Gets the value(s) for telecom (). creating it if it does not exist. Will not return null.

        Definition: A contact detail for the practitioner, e.g. a telephone number or an email address.

      • setTelecom

        public Practitioner setTelecom​(List<ContactPointDt> theValue)
        Sets the value(s) for telecom ()

        Definition: A contact detail for the practitioner, e.g. a telephone number or an email address.

      • addTelecom

        public ContactPointDt addTelecom()
        Adds and returns a new value for telecom ()

        Definition: A contact detail for the practitioner, e.g. a telephone number or an email address.

      • addTelecom

        public Practitioner addTelecom​(ContactPointDt theValue)
        Adds a given new value for telecom ()

        Definition: A contact detail for the practitioner, e.g. a telephone number or an email address.

        Parameters:
        theValue - The telecom to add (must not be null)

      • getTelecomFirstRep

        public ContactPointDt getTelecomFirstRep()
        Gets the first repetition for telecom (), creating it if it does not already exist.

        Definition: A contact detail for the practitioner, e.g. a telephone number or an email address.

      • getAddress

        public List<AddressDt> getAddress()
        Gets the value(s) for address (). creating it if it does not exist. Will not return null.

        Definition: The postal address where the practitioner can be found or visited or to which mail can be delivered

      • setAddress

        public Practitioner setAddress​(List<AddressDt> theValue)
        Sets the value(s) for address ()

        Definition: The postal address where the practitioner can be found or visited or to which mail can be delivered

      • addAddress

        public AddressDt addAddress()
        Adds and returns a new value for address ()

        Definition: The postal address where the practitioner can be found or visited or to which mail can be delivered

      • addAddress

        public Practitioner addAddress​(AddressDt theValue)
        Adds a given new value for address ()

        Definition: The postal address where the practitioner can be found or visited or to which mail can be delivered

        Parameters:
        theValue - The address to add (must not be null)

      • getAddressFirstRep

        public AddressDt getAddressFirstRep()
        Gets the first repetition for address (), creating it if it does not already exist.

        Definition: The postal address where the practitioner can be found or visited or to which mail can be delivered

      • getGenderElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<AdministrativeGenderEnum> getGenderElement()
        Gets the value(s) for gender (). creating it if it does not exist. Will not return null.

        Definition: Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

      • getGender

        public String getGender()
        Gets the value(s) for gender (). creating it if it does not exist. This method may return null.

        Definition: Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

      • setGender

        public Practitioner setGender​(ca.uhn.fhir.model.primitive.BoundCodeDt<AdministrativeGenderEnum> theValue)
        Sets the value(s) for gender ()

        Definition: Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

      • setGender

        public Practitioner setGender​(AdministrativeGenderEnum theValue)
        Sets the value(s) for gender ()

        Definition: Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

      • getBirthDateElement

        public ca.uhn.fhir.model.primitive.DateDt getBirthDateElement()
        Gets the value(s) for birthDate (). creating it if it does not exist. Will not return null.

        Definition: The date of birth for the practitioner

      • getBirthDate

        public Date getBirthDate()
        Gets the value(s) for birthDate (). creating it if it does not exist. This method may return null.

        Definition: The date of birth for the practitioner

      • setBirthDate

        public Practitioner setBirthDate​(ca.uhn.fhir.model.primitive.DateDt theValue)
        Sets the value(s) for birthDate ()

        Definition: The date of birth for the practitioner

      • setBirthDate

        public Practitioner setBirthDate​(Date theDate,
                                 ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for birthDate ()

        Definition: The date of birth for the practitioner

      • getPhoto

        public List<AttachmentDt> getPhoto()
        Gets the value(s) for photo (). creating it if it does not exist. Will not return null.

        Definition: Image of the person

      • addPhoto

        public AttachmentDt addPhoto()
        Adds and returns a new value for photo ()

        Definition: Image of the person

      • addPhoto

        public Practitioner addPhoto​(AttachmentDt theValue)
        Adds a given new value for photo ()

        Definition: Image of the person

        Parameters:
        theValue - The photo to add (must not be null)

      • getPhotoFirstRep

        public AttachmentDt getPhotoFirstRep()
        Gets the first repetition for photo (), creating it if it does not already exist.

        Definition: Image of the person

      • getPractitionerRole

        public List<Practitioner.PractitionerRole> getPractitionerRole()
        Gets the value(s) for practitionerRole (). creating it if it does not exist. Will not return null.

        Definition: The list of roles/organizations that the practitioner is associated with

      • addPractitionerRole

        public Practitioner addPractitionerRole​(Practitioner.PractitionerRole theValue)
        Adds a given new value for practitionerRole ()

        Definition: The list of roles/organizations that the practitioner is associated with

        Parameters:
        theValue - The practitionerRole to add (must not be null)

      • getCommunication

        public List<CodeableConceptDt> getCommunication()
        Gets the value(s) for communication (). creating it if it does not exist. Will not return null.

        Definition: A language the practitioner is able to use in patient communication

      • addCommunication

        public CodeableConceptDt addCommunication()
        Adds and returns a new value for communication ()

        Definition: A language the practitioner is able to use in patient communication

      • addCommunication

        public Practitioner addCommunication​(CodeableConceptDt theValue)
        Adds a given new value for communication ()

        Definition: A language the practitioner is able to use in patient communication

        Parameters:
        theValue - The communication to add (must not be null)

      • getCommunicationFirstRep

        public CodeableConceptDt getCommunicationFirstRep()
        Gets the first repetition for communication (), creating it if it does not already exist.

        Definition: A language the practitioner is able to use in patient communication

      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource

      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource