Practitioner (HAPI FHIR Structures - HL7.org DSTU2 3.3.0 API)

java.lang.Object
- org.hl7.fhir.instance.model.Base
- - org.hl7.fhir.instance.model.BaseResource
  - - org.hl7.fhir.instance.model.Resource
    - - org.hl7.fhir.instance.model.DomainResource
      - org.hl7.fhir.instance.model.Practitioner

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource
```
public class Practitioner
extends DomainResource
```
A person who is directly or indirectly involved in the provisioning of healthcare.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Practitioner.PractitionerPractitionerRoleComponent

static class Practitioner.PractitionerQualificationComponent

Nested Classes
Modifier and Type	Class and Description
`static class`	`Practitioner.PractitionerPractitionerRoleComponent`
`static class`	`Practitioner.PractitionerQualificationComponent`

Field Summary

Fields
Modifier and Type	Field and Description
`protected BooleanType`	`active` Whether this practitioner's record is in active use.
`protected List<Address>`	`address` The postal address where the practitioner can be found or visited or to which mail can be delivered.
`protected DateType`	`birthDate` The date of birth for the practitioner.
`protected List<CodeableConcept>`	`communication` A language the practitioner is able to use in patient communication.
`protected Enumeration<Enumerations.AdministrativeGender>`	`gender` Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
`protected List<Identifier>`	`identifier` An identifier that applies to this person in this role.
`protected HumanName`	`name` A name associated with the person.
`protected List<Attachment>`	`photo` Image of the person.
`protected List<Practitioner.PractitionerPractitionerRoleComponent>`	`practitionerRole` The list of roles/organizations that the practitioner is associated with.
`protected List<Practitioner.PractitionerQualificationComponent>`	`qualification` Qualifications obtained by training and certification.
`static String`	`SP_ADDRESS`
`static String`	`SP_ADDRESSCITY`
`static String`	`SP_ADDRESSCOUNTRY`
`static String`	`SP_ADDRESSPOSTALCODE`
`static String`	`SP_ADDRESSSTATE`
`static String`	`SP_ADDRESSUSE`
`static String`	`SP_COMMUNICATION`
`static String`	`SP_EMAIL`
`static String`	`SP_FAMILY`
`static String`	`SP_GENDER`
`static String`	`SP_GIVEN`
`static String`	`SP_IDENTIFIER`
`static String`	`SP_LOCATION`
`static String`	`SP_NAME`
`static String`	`SP_ORGANIZATION`
`static String`	`SP_PHONE`
`static String`	`SP_PHONETIC`
`static String`	`SP_ROLE`
`static String`	`SP_SPECIALTY`
`static String`	`SP_TELECOM`
`protected List<ContactPoint>`	`telecom` A contact detail for the practitioner, e.g.

Fields inherited from class org.hl7.fhir.instance.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.instance.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description

Practitioner()

Constructors
Constructor and Description
`Practitioner()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Address`	`addAddress()`
`Practitioner`	`addAddress(Address t)`
`Base`	`addChild(String name)`
`CodeableConcept`	`addCommunication()`
`Practitioner`	`addCommunication(CodeableConcept t)`
`Identifier`	`addIdentifier()`
`Practitioner`	`addIdentifier(Identifier t)`
`Attachment`	`addPhoto()`
`Practitioner`	`addPhoto(Attachment t)`
`Practitioner.PractitionerPractitionerRoleComponent`	`addPractitionerRole()`
`Practitioner`	`addPractitionerRole(Practitioner.PractitionerPractitionerRoleComponent t)`
`Practitioner.PractitionerQualificationComponent`	`addQualification()`
`Practitioner`	`addQualification(Practitioner.PractitionerQualificationComponent t)`
`ContactPoint`	`addTelecom()`
`Practitioner`	`addTelecom(ContactPoint t)`
`Practitioner`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`boolean`	`getActive()`
`BooleanType`	`getActiveElement()`
`List<Address>`	`getAddress()`
`Date`	`getBirthDate()`
`DateType`	`getBirthDateElement()`
`List<CodeableConcept>`	`getCommunication()`
`Enumerations.AdministrativeGender`	`getGender()`
`Enumeration<Enumerations.AdministrativeGender>`	`getGenderElement()`
`List<Identifier>`	`getIdentifier()`
`HumanName`	`getName()`
`List<Attachment>`	`getPhoto()`
`List<Practitioner.PractitionerPractitionerRoleComponent>`	`getPractitionerRole()`
`List<Practitioner.PractitionerQualificationComponent>`	`getQualification()`
`ResourceType`	`getResourceType()`
`List<ContactPoint>`	`getTelecom()`
`boolean`	`hasActive()`
`boolean`	`hasActiveElement()`
`boolean`	`hasAddress()`
`boolean`	`hasBirthDate()`
`boolean`	`hasBirthDateElement()`
`boolean`	`hasCommunication()`
`boolean`	`hasGender()`
`boolean`	`hasGenderElement()`
`boolean`	`hasIdentifier()`
`boolean`	`hasName()`
`boolean`	`hasPhoto()`
`boolean`	`hasPractitionerRole()`
`boolean`	`hasQualification()`
`boolean`	`hasTelecom()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Practitioner`	`setActive(boolean value)`
`Practitioner`	`setActiveElement(BooleanType value)`
`Practitioner`	`setBirthDate(Date value)`
`Practitioner`	`setBirthDateElement(DateType value)`
`Practitioner`	`setGender(Enumerations.AdministrativeGender value)`
`Practitioner`	`setGenderElement(Enumeration<Enumerations.AdministrativeGender> value)`
`Practitioner`	`setName(HumanName value)`
`void`	`setProperty(String name, Base value)`
`protected Practitioner`	`typedCopy()`

Methods inherited from class org.hl7.fhir.instance.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.instance.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, getStructureFhirVersionEnum, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.instance.model.BaseResource
setId

Methods inherited from class org.hl7.fhir.instance.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Field Detail
  - identifier
```
protected List<Identifier> identifier
```
    An identifier that applies to this person in this role.
  - active
```
protected BooleanType active
```
    Whether this practitioner's record is in active use.
  - name
```
protected HumanName name
```
    A name associated with the person.
  - telecom
```
protected List<ContactPoint> telecom
```
    A contact detail for the practitioner, e.g. a telephone number or an email address.
  - address
```
protected List<Address> address
```
    The postal address where the practitioner can be found or visited or to which mail can be delivered.
  - gender
```
protected Enumeration<Enumerations.AdministrativeGender> gender
```
    Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
  - birthDate
```
protected DateType birthDate
```
    The date of birth for the practitioner.
  - photo
```
protected List<Attachment> photo
```
    Image of the person.
  - practitionerRole
```
protected List<Practitioner.PractitionerPractitionerRoleComponent> practitionerRole
```
    The list of roles/organizations that the practitioner is associated with.
  - qualification
```
protected List<Practitioner.PractitionerQualificationComponent> qualification
```
    Qualifications obtained by training and certification.
  - communication
```
protected List<CodeableConcept> communication
```
    A language the practitioner is able to use in patient communication.
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - SP_GIVEN
```
public static final String SP_GIVEN
```
    See Also:
    
    Constant Field Values
  - SP_SPECIALTY
```
public static final String SP_SPECIALTY
```
    See Also:
    
    Constant Field Values
  - SP_ADDRESS
```
public static final String SP_ADDRESS
```
    See Also:
    
    Constant Field Values
  - SP_ROLE
```
public static final String SP_ROLE
```
    See Also:
    
    Constant Field Values
  - SP_ADDRESSSTATE
```
public static final String SP_ADDRESSSTATE
```
    See Also:
    
    Constant Field Values
  - SP_GENDER
```
public static final String SP_GENDER
```
    See Also:
    
    Constant Field Values
  - SP_ADDRESSPOSTALCODE
```
public static final String SP_ADDRESSPOSTALCODE
```
    See Also:
    
    Constant Field Values
  - SP_ADDRESSCOUNTRY
```
public static final String SP_ADDRESSCOUNTRY
```
    See Also:
    
    Constant Field Values
  - SP_PHONETIC
```
public static final String SP_PHONETIC
```
    See Also:
    
    Constant Field Values
  - SP_PHONE
```
public static final String SP_PHONE
```
    See Also:
    
    Constant Field Values
  - SP_ORGANIZATION
```
public static final String SP_ORGANIZATION
```
    See Also:
    
    Constant Field Values
  - SP_NAME
```
public static final String SP_NAME
```
    See Also:
    
    Constant Field Values
  - SP_ADDRESSUSE
```
public static final String SP_ADDRESSUSE
```
    See Also:
    
    Constant Field Values
  - SP_TELECOM
```
public static final String SP_TELECOM
```
    See Also:
    
    Constant Field Values
  - SP_LOCATION
```
public static final String SP_LOCATION
```
    See Also:
    
    Constant Field Values
  - SP_FAMILY
```
public static final String SP_FAMILY
```
    See Also:
    
    Constant Field Values
  - SP_ADDRESSCITY
```
public static final String SP_ADDRESSCITY
```
    See Also:
    
    Constant Field Values
  - SP_COMMUNICATION
```
public static final String SP_COMMUNICATION
```
    See Also:
    
    Constant Field Values
  - SP_EMAIL
```
public static final String SP_EMAIL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Practitioner
```
public Practitioner()
```
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (An identifier that applies to this person in this role.)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
    Returns:
    
    identifier (An identifier that applies to this person in this role.)
  - addIdentifier
```
public Practitioner addIdentifier(Identifier t)
```
  - getActiveElement
```
public BooleanType getActiveElement()
```
    Returns:
    
    active (Whether this practitioner's record is in active use.). This is the underlying object with id, value and extensions. The accessor "getActive" gives direct access to the value
  - hasActiveElement
```
public boolean hasActiveElement()
```
  - hasActive
```
public boolean hasActive()
```
  - setActiveElement
```
public Practitioner setActiveElement(BooleanType value)
```
    Parameters:
    
    value - active (Whether this practitioner's record is in active use.). This is the underlying object with id, value and extensions. The accessor "getActive" gives direct access to the value
  - getActive
```
public boolean getActive()
```
    Returns:
    
    Whether this practitioner's record is in active use.
  - setActive
```
public Practitioner setActive(boolean value)
```
    Parameters:
    
    value - Whether this practitioner's record is in active use.
  - getName
```
public HumanName getName()
```
    Returns:
    
    name (A name associated with the person.)
  - hasName
```
public boolean hasName()
```
  - setName
```
public Practitioner setName(HumanName value)
```
    Parameters:
    
    value - name (A name associated with the person.)
  - getTelecom
```
public List<ContactPoint> getTelecom()
```
    Returns:
    
    telecom (A contact detail for the practitioner, e.g. a telephone number or an email address.)
  - hasTelecom
```
public boolean hasTelecom()
```
  - addTelecom
```
public ContactPoint addTelecom()
```
    Returns:
    
    telecom (A contact detail for the practitioner, e.g. a telephone number or an email address.)
  - addTelecom
```
public Practitioner addTelecom(ContactPoint t)
```
  - getAddress
```
public List<Address> getAddress()
```
    Returns:
    
    address (The postal address where the practitioner can be found or visited or to which mail can be delivered.)
  - hasAddress
```
public boolean hasAddress()
```
  - addAddress
```
public Address addAddress()
```
    Returns:
    
    address (The postal address where the practitioner can be found or visited or to which mail can be delivered.)
  - addAddress
```
public Practitioner addAddress(Address t)
```
  - getGenderElement
```
public Enumeration<Enumerations.AdministrativeGender> getGenderElement()
```
    Returns:
    
    gender (Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.). This is the underlying object with id, value and extensions. The accessor "getGender" gives direct access to the value
  - hasGenderElement
```
public boolean hasGenderElement()
```
  - hasGender
```
public boolean hasGender()
```
  - setGenderElement
```
public Practitioner setGenderElement(Enumeration<Enumerations.AdministrativeGender> value)
```
    Parameters:
    
    value - gender (Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.). This is the underlying object with id, value and extensions. The accessor "getGender" gives direct access to the value
  - getGender
```
public Enumerations.AdministrativeGender getGender()
```
    Returns:
    
    Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
  - setGender
```
public Practitioner setGender(Enumerations.AdministrativeGender value)
```
    Parameters:
    
    value - Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
  - getBirthDateElement
```
public DateType getBirthDateElement()
```
    Returns:
    
    birthDate (The date of birth for the practitioner.). This is the underlying object with id, value and extensions. The accessor "getBirthDate" gives direct access to the value
  - hasBirthDateElement
```
public boolean hasBirthDateElement()
```
  - hasBirthDate
```
public boolean hasBirthDate()
```
  - setBirthDateElement
```
public Practitioner setBirthDateElement(DateType value)
```
    Parameters:
    
    value - birthDate (The date of birth for the practitioner.). This is the underlying object with id, value and extensions. The accessor "getBirthDate" gives direct access to the value
  - getBirthDate
```
public Date getBirthDate()
```
    Returns:
    
    The date of birth for the practitioner.
  - setBirthDate
```
public Practitioner setBirthDate(Date value)
```
    Parameters:
    
    value - The date of birth for the practitioner.
  - getPhoto
```
public List<Attachment> getPhoto()
```
    Returns:
    
    photo (Image of the person.)
  - hasPhoto
```
public boolean hasPhoto()
```
  - addPhoto
```
public Attachment addPhoto()
```
    Returns:
    
    photo (Image of the person.)
  - addPhoto
```
public Practitioner addPhoto(Attachment t)
```
  - getPractitionerRole
```
public List<Practitioner.PractitionerPractitionerRoleComponent> getPractitionerRole()
```
    Returns:
    
    practitionerRole (The list of roles/organizations that the practitioner is associated with.)
  - hasPractitionerRole
```
public boolean hasPractitionerRole()
```
  - addPractitionerRole
```
public Practitioner.PractitionerPractitionerRoleComponent addPractitionerRole()
```
    Returns:
    
    practitionerRole (The list of roles/organizations that the practitioner is associated with.)
  - addPractitionerRole
```
public Practitioner addPractitionerRole(Practitioner.PractitionerPractitionerRoleComponent t)
```
  - getQualification
```
public List<Practitioner.PractitionerQualificationComponent> getQualification()
```
    Returns:
    
    qualification (Qualifications obtained by training and certification.)
  - hasQualification
```
public boolean hasQualification()
```
  - addQualification
```
public Practitioner.PractitionerQualificationComponent addQualification()
```
    Returns:
    
    qualification (Qualifications obtained by training and certification.)
  - addQualification
```
public Practitioner addQualification(Practitioner.PractitionerQualificationComponent t)
```
  - getCommunication
```
public List<CodeableConcept> getCommunication()
```
    Returns:
    
    communication (A language the practitioner is able to use in patient communication.)
  - hasCommunication
```
public boolean hasCommunication()
```
  - addCommunication
```
public CodeableConcept addCommunication()
```
    Returns:
    
    communication (A language the practitioner is able to use in patient communication.)
  - addCommunication
```
public Practitioner addCommunication(CodeableConcept t)
```
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class DomainResource
  - setProperty
```
public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - fhirType
```
public String fhirType()
```
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public Practitioner copy()
```
    Specified by:
    
    copy in class DomainResource
  - typedCopy
```
protected Practitioner typedCopy()
```
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class DomainResource
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class DomainResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class Practitioner

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.instance.model.DomainResource

Fields inherited from class org.hl7.fhir.instance.model.Resource

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.instance.model.DomainResource

Methods inherited from class org.hl7.fhir.instance.model.Resource

Methods inherited from class org.hl7.fhir.instance.model.BaseResource

Methods inherited from class org.hl7.fhir.instance.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Field Detail

identifier

active

name

telecom

address

gender

birthDate

photo

practitionerRole

qualification

communication

SP_IDENTIFIER

SP_GIVEN

SP_SPECIALTY

SP_ADDRESS

SP_ROLE

SP_ADDRESSSTATE

SP_GENDER

SP_ADDRESSPOSTALCODE

SP_ADDRESSCOUNTRY

SP_PHONETIC

SP_PHONE

SP_ORGANIZATION

SP_NAME

SP_ADDRESSUSE

SP_TELECOM

SP_LOCATION

SP_FAMILY

SP_ADDRESSCITY

SP_COMMUNICATION

SP_EMAIL

Constructor Detail

Practitioner

Method Detail

getIdentifier

hasIdentifier

addIdentifier

addIdentifier

getActiveElement

hasActiveElement

hasActive

setActiveElement

getActive

setActive

getName

hasName

setName

getTelecom

hasTelecom

addTelecom

addTelecom

getAddress

hasAddress

addAddress

addAddress

getGenderElement

hasGenderElement

hasGender

setGenderElement

getGender

setGender

getBirthDateElement