Class 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
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionprotected BooleanType
Whether this practitioner's record is in active use.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for activeAddress(es) of the practitioner that are not role specific (typically home address).static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for addressstatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for address-citystatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for address-countrystatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for address-postalcodestatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for address-statestatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for address-useprotected DateType
The date of birth for the practitioner.protected List
<CodeableConcept> A language the practitioner can use in patient communication.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for communicationstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for emailstatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for familyprotected Enumeration
<Enumerations.AdministrativeGender> Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for genderstatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for givenprotected List
<Identifier> An identifier that applies to this person in this role.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierThe name(s) associated with the practitioner.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for namestatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for phonestatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for phoneticprotected List
<Attachment> Image of the person.The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner.static final String
Search parameter: activestatic final String
Search parameter: addressstatic final String
Search parameter: address-citystatic final String
Search parameter: address-countrystatic final String
Search parameter: address-postalcodestatic final String
Search parameter: address-statestatic final String
Search parameter: address-usestatic final String
Search parameter: communicationstatic final String
Search parameter: emailstatic final String
Search parameter: familystatic final String
Search parameter: genderstatic final String
Search parameter: givenstatic final String
Search parameter: identifierstatic final String
Search parameter: namestatic final String
Search parameter: phonestatic final String
Search parameter: phoneticstatic final String
Search parameter: telecomprotected List
<ContactPoint> A contact detail for the practitioner, e.g.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for telecomFields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddName()
addPhoto()
copy()
void
copyValues
(Practitioner dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
boolean
getName()
getNamedProperty
(int _hash, String _name, boolean _checkValid) getPhoto()
Base[]
getProperty
(int hash, String name, boolean checkValid) String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasName()
boolean
hasPhoto()
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setActive
(boolean value) setActiveElement
(BooleanType value) setAddress
(List<Address> theAddress) setBirthDate
(Date value) setBirthDateElement
(DateType value) setCommunication
(List<CodeableConcept> theCommunication) setIdentifier
(List<Identifier> theIdentifier) setPhoto
(List<Attachment> thePhoto) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setQualification
(List<Practitioner.PractitionerQualificationComponent> theQualification) setTelecom
(List<ContactPoint> theTelecom) protected Practitioner
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, 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.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
An identifier that applies to this person in this role. -
active
Whether this practitioner's record is in active use. -
name
The name(s) associated with the practitioner. -
telecom
A contact detail for the practitioner, e.g. a telephone number or an email address. -
address
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. -
gender
Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. -
birthDate
The date of birth for the practitioner. -
photo
Image of the person. -
qualification
The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality. -
communication
A language the practitioner can use in patient communication. -
SP_IDENTIFIER
Search parameter: identifierDescription: A practitioner's Identifier
Type: token
Path: Practitioner.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: A practitioner's Identifier
Type: token
Path: Practitioner.identifier
-
SP_GIVEN
Search parameter: givenDescription: A portion of the given name
Type: string
Path: Practitioner.name.given
- See Also:
-
GIVEN
Fluent Client search parameter constant for givenDescription: A portion of the given name
Type: string
Path: Practitioner.name.given
-
SP_ADDRESS
Search parameter: addressDescription: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
Type: string
Path: Practitioner.address
- See Also:
-
ADDRESS
Fluent Client search parameter constant for addressDescription: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
Type: string
Path: Practitioner.address
-
SP_ADDRESS_STATE
Search parameter: address-stateDescription: A state specified in an address
Type: string
Path: Practitioner.address.state
- See Also:
-
ADDRESS_STATE
Fluent Client search parameter constant for address-stateDescription: A state specified in an address
Type: string
Path: Practitioner.address.state
-
SP_GENDER
Search parameter: genderDescription: Gender of the practitioner
Type: token
Path: Practitioner.gender
- See Also:
-
GENDER
Fluent Client search parameter constant for genderDescription: Gender of the practitioner
Type: token
Path: Practitioner.gender
-
SP_ACTIVE
Search parameter: activeDescription: Whether the practitioner record is active
Type: token
Path: Practitioner.active
- See Also:
-
ACTIVE
Fluent Client search parameter constant for activeDescription: Whether the practitioner record is active
Type: token
Path: Practitioner.active
-
SP_ADDRESS_POSTALCODE
Search parameter: address-postalcodeDescription: A postalCode specified in an address
Type: string
Path: Practitioner.address.postalCode
- See Also:
-
ADDRESS_POSTALCODE
Fluent Client search parameter constant for address-postalcodeDescription: A postalCode specified in an address
Type: string
Path: Practitioner.address.postalCode
-
SP_ADDRESS_COUNTRY
Search parameter: address-countryDescription: A country specified in an address
Type: string
Path: Practitioner.address.country
- See Also:
-
ADDRESS_COUNTRY
Fluent Client search parameter constant for address-countryDescription: A country specified in an address
Type: string
Path: Practitioner.address.country
-
SP_PHONETIC
Search parameter: phoneticDescription: A portion of either family or given name using some kind of phonetic matching algorithm
Type: string
Path: Practitioner.name
- See Also:
-
PHONETIC
Fluent Client search parameter constant for phoneticDescription: A portion of either family or given name using some kind of phonetic matching algorithm
Type: string
Path: Practitioner.name
-
SP_PHONE
Search parameter: phoneDescription: A value in a phone contact
Type: token
Path: Practitioner.telecom(system=phone)
- See Also:
-
PHONE
Fluent Client search parameter constant for phoneDescription: A value in a phone contact
Type: token
Path: Practitioner.telecom(system=phone)
-
SP_NAME
Search parameter: nameDescription: A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
Type: string
Path: Practitioner.name
- See Also:
-
NAME
Fluent Client search parameter constant for nameDescription: A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
Type: string
Path: Practitioner.name
-
SP_ADDRESS_USE
Search parameter: address-useDescription: A use code specified in an address
Type: token
Path: Practitioner.address.use
- See Also:
-
ADDRESS_USE
Fluent Client search parameter constant for address-useDescription: A use code specified in an address
Type: token
Path: Practitioner.address.use
-
SP_TELECOM
Search parameter: telecomDescription: The value in any kind of contact
Type: token
Path: Practitioner.telecom
- See Also:
-
TELECOM
Fluent Client search parameter constant for telecomDescription: The value in any kind of contact
Type: token
Path: Practitioner.telecom
-
SP_FAMILY
Search parameter: familyDescription: A portion of the family name
Type: string
Path: Practitioner.name.family
- See Also:
-
FAMILY
Fluent Client search parameter constant for familyDescription: A portion of the family name
Type: string
Path: Practitioner.name.family
-
SP_ADDRESS_CITY
Search parameter: address-cityDescription: A city specified in an address
Type: string
Path: Practitioner.address.city
- See Also:
-
ADDRESS_CITY
Fluent Client search parameter constant for address-cityDescription: A city specified in an address
Type: string
Path: Practitioner.address.city
-
SP_COMMUNICATION
Search parameter: communicationDescription: One of the languages that the practitioner can communicate with
Type: token
Path: Practitioner.communication
- See Also:
-
COMMUNICATION
Fluent Client search parameter constant for communicationDescription: One of the languages that the practitioner can communicate with
Type: token
Path: Practitioner.communication
-
SP_EMAIL
Search parameter: emailDescription: A value in an email contact
Type: token
Path: Practitioner.telecom(system=email)
- See Also:
-
EMAIL
Fluent Client search parameter constant for emailDescription: A value in an email contact
Type: token
Path: Practitioner.telecom(system=email)
-
-
Constructor Details
-
Practitioner
public Practitioner()Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(An identifier that applies to this person in this role.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
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
-
hasActive
-
setActiveElement
- 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
- Returns:
- Whether this practitioner's record is in active use.
-
setActive
- Parameters:
value
- Whether this practitioner's record is in active use.
-
getName
- Returns:
name
(The name(s) associated with the practitioner.)
-
setName
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasName
-
addName
-
addName
-
getNameFirstRep
- Returns:
- The first repetition of repeating field
name
, creating it if it does not already exist
-
getTelecom
- Returns:
telecom
(A contact detail for the practitioner, e.g. a telephone number or an email address.)
-
setTelecom
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasTelecom
-
addTelecom
-
addTelecom
-
getTelecomFirstRep
- Returns:
- The first repetition of repeating field
telecom
, creating it if it does not already exist
-
getAddress
- Returns:
address
(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.)
-
setAddress
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAddress
-
addAddress
-
addAddress
-
getAddressFirstRep
- Returns:
- The first repetition of repeating field
address
, creating it if it does not already exist
-
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
-
hasGender
-
setGenderElement
- 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
- Returns:
- Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
-
setGender
- Parameters:
value
- Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
-
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
-
hasBirthDate
-
setBirthDateElement
- 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
- Returns:
- The date of birth for the practitioner.
-
setBirthDate
- Parameters:
value
- The date of birth for the practitioner.
-
getPhoto
- Returns:
photo
(Image of the person.)
-
setPhoto
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPhoto
-
addPhoto
-
addPhoto
-
getPhotoFirstRep
- Returns:
- The first repetition of repeating field
photo
, creating it if it does not already exist
-
getQualification
- Returns:
qualification
(The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.)
-
setQualification
public Practitioner setQualification(List<Practitioner.PractitionerQualificationComponent> theQualification) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasQualification
-
addQualification
-
addQualification
-
getQualificationFirstRep
- Returns:
- The first repetition of repeating field
qualification
, creating it if it does not already exist
-
getCommunication
- Returns:
communication
(A language the practitioner can use in patient communication.)
-
setCommunication
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCommunication
-
addCommunication
-
addCommunication
-
getCommunicationFirstRep
- Returns:
- The first repetition of repeating field
communication
, creating it if it does not already exist
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-