Package org.hl7.fhir.r5.model

Class PractitionerRole

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.model.PractitionerRole

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 PractitionerRole
extends DomainResource

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

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected BooleanType	active	Whether this practitioner role record is in active use.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	ACTIVE	Fluent Client search parameter constant for active
protected List<Availability>	availability	A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
protected List<CodeableConcept>	characteristic	Collection of characteristics (attributes).
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CHARACTERISTIC	Fluent Client search parameter constant for characteristic
protected List<CodeableConcept>	code	Roles which this practitioner is authorized to perform for the organization.
protected List<CodeableConcept>	communication	A language the practitioner can use in patient communication.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	COMMUNICATION	Fluent Client search parameter constant for communication
protected List<ExtendedContactDetail>	contact	The contact details of communication devices available relevant to the specific PractitionerRole.
static final ca.uhn.fhir.rest.gclient.DateClientParam	DATE	Fluent Client search parameter constant for date
static final ca.uhn.fhir.rest.gclient.TokenClientParam	EMAIL	Fluent Client search parameter constant for email
protected List<Reference>	endpoint	Technical endpoints providing access to services operated for the practitioner with this role.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ENDPOINT	Fluent Client search parameter constant for endpoint
protected List<Reference>	healthcareService	The list of healthcare services that this worker provides for this role's Organization/Location(s).
protected List<Identifier>	identifier	Business Identifiers that are specific to a role/location.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_ENDPOINT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_LOCATION	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_ORGANIZATION	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PRACTITIONER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SERVICE	Constant for fluent queries to be used to add include statements.
protected List<Reference>	location	The location(s) at which this practitioner provides care.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	LOCATION	Fluent Client search parameter constant for location
protected Reference	organization	The organization where the Practitioner performs the roles associated.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ORGANIZATION	Fluent Client search parameter constant for organization
protected Period	period	The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	PHONE	Fluent Client search parameter constant for phone
protected Reference	practitioner	Practitioner that is able to provide the defined services for the organization.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PRACTITIONER	Fluent Client search parameter constant for practitioner
static final ca.uhn.fhir.rest.gclient.TokenClientParam	ROLE	Fluent Client search parameter constant for role
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SERVICE	Fluent Client search parameter constant for service
static final String	SP_ACTIVE	Search parameter: active
static final String	SP_CHARACTERISTIC	Search parameter: characteristic
static final String	SP_COMMUNICATION	Search parameter: communication
static final String	SP_DATE	Search parameter: date
static final String	SP_EMAIL	Search parameter: email
static final String	SP_ENDPOINT	Search parameter: endpoint
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_LOCATION	Search parameter: location
static final String	SP_ORGANIZATION	Search parameter: organization
static final String	SP_PHONE	Search parameter: phone
static final String	SP_PRACTITIONER	Search parameter: practitioner
static final String	SP_ROLE	Search parameter: role
static final String	SP_SERVICE	Search parameter: service
static final String	SP_SPECIALTY	Search parameter: specialty
static final String	SP_TELECOM	Search parameter: telecom
protected List<CodeableConcept>	specialty	The specialty of a practitioner that describes the functional role they are practicing at a given organization or location.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SPECIALTY	Fluent Client search parameter constant for specialty
static final ca.uhn.fhir.rest.gclient.TokenClientParam	TELECOM	Fluent Client search parameter constant for telecom

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

contained, extension, modifierExtension, SP_TEXT, text, TEXT

Fields inherited from class org.hl7.fhir.r5.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

Constructors

Constructor	Description
PractitionerRole()	Constructor

Method Summary

Modifier and Type	Method	Description
Availability	addAvailability()
PractitionerRole	addAvailability(Availability t)
CodeableConcept	addCharacteristic()
PractitionerRole	addCharacteristic(CodeableConcept t)
Base	addChild(String name)
CodeableConcept	addCode()
PractitionerRole	addCode(CodeableConcept t)
CodeableConcept	addCommunication()
PractitionerRole	addCommunication(CodeableConcept t)
ExtendedContactDetail	addContact()
PractitionerRole	addContact(ExtendedContactDetail t)
Reference	addEndpoint()
PractitionerRole	addEndpoint(Reference t)
Reference	addHealthcareService()
PractitionerRole	addHealthcareService(Reference t)
Identifier	addIdentifier()
PractitionerRole	addIdentifier(Identifier t)
Reference	addLocation()
PractitionerRole	addLocation(Reference t)
CodeableConcept	addSpecialty()
PractitionerRole	addSpecialty(CodeableConcept t)
PractitionerRole	copy()
void	copyValues(PractitionerRole dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
boolean	getActive()
BooleanType	getActiveElement()
List<Availability>	getAvailability()
Availability	getAvailabilityFirstRep()
List<CodeableConcept>	getCharacteristic()
CodeableConcept	getCharacteristicFirstRep()
List<CodeableConcept>	getCode()
CodeableConcept	getCodeFirstRep()
List<CodeableConcept>	getCommunication()
CodeableConcept	getCommunicationFirstRep()
List<ExtendedContactDetail>	getContact()
ExtendedContactDetail	getContactFirstRep()
List<Reference>	getEndpoint()
Reference	getEndpointFirstRep()
List<Reference>	getHealthcareService()
Reference	getHealthcareServiceFirstRep()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<Reference>	getLocation()
Reference	getLocationFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Reference	getOrganization()
Period	getPeriod()
Reference	getPractitioner()
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
List<CodeableConcept>	getSpecialty()
CodeableConcept	getSpecialtyFirstRep()
String[]	getTypesForProperty(int hash, String name)
boolean	hasActive()
boolean	hasActiveElement()
boolean	hasAvailability()
boolean	hasCharacteristic()
boolean	hasCode()
boolean	hasCommunication()
boolean	hasContact()
boolean	hasEndpoint()
boolean	hasHealthcareService()
boolean	hasIdentifier()
boolean	hasLocation()
boolean	hasOrganization()
boolean	hasPeriod()
boolean	hasPractitioner()
boolean	hasSpecialty()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
PractitionerRole	setActive(boolean value)
PractitionerRole	setActiveElement(BooleanType value)
PractitionerRole	setAvailability(List<Availability> theAvailability)
PractitionerRole	setCharacteristic(List<CodeableConcept> theCharacteristic)
PractitionerRole	setCode(List<CodeableConcept> theCode)
PractitionerRole	setCommunication(List<CodeableConcept> theCommunication)
PractitionerRole	setContact(List<ExtendedContactDetail> theContact)
PractitionerRole	setEndpoint(List<Reference> theEndpoint)
PractitionerRole	setHealthcareService(List<Reference> theHealthcareService)
PractitionerRole	setIdentifier(List<Identifier> theIdentifier)
PractitionerRole	setLocation(List<Reference> theLocation)
PractitionerRole	setOrganization(Reference value)
PractitionerRole	setPeriod(Period value)
PractitionerRole	setPractitioner(Reference value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
PractitionerRole	setSpecialty(List<CodeableConcept> theSpecialty)
protected PractitionerRole	typedCopy()

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

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setText

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

copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath

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

getStructureFhirVersionEnum, isResource, setId

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, 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

protected List<Identifier> identifier

Business Identifiers that are specific to a role/location.

active

protected BooleanType active

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.

period

protected Period period

The period during which the person is authorized to act as a practitioner in these role(s) for the organization.

practitioner

protected Reference practitioner

Practitioner that is able to provide the defined services for the organization.

organization

protected Reference organization

The organization where the Practitioner performs the roles associated.

code

protected List<CodeableConcept> code

Roles which this practitioner is authorized to perform for the organization.

specialty

protected List<CodeableConcept> specialty

The specialty of a practitioner that describes the functional role they are practicing at a given organization or location.

location

protected List<Reference> location

The location(s) at which this practitioner provides care.

healthcareService

protected List<Reference> healthcareService

The list of healthcare services that this worker provides for this role's Organization/Location(s).

contact

protected List<ExtendedContactDetail> contact

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.

characteristic

protected List<CodeableConcept> characteristic

Collection of characteristics (attributes).

communication

protected List<CodeableConcept> communication

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.

availability

protected List<Availability> availability

A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.

endpoint

protected List<Reference> endpoint

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.

SP_ACTIVE

public static final String SP_ACTIVE

Search parameter: active

Description: Whether this practitioner role record is in active use
Type: token
Path: PractitionerRole.active

See Also:

• Constant Field Values

ACTIVE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam ACTIVE

Fluent Client search parameter constant for active

Description: Whether this practitioner role record is in active use
Type: token
Path: PractitionerRole.active

SP_CHARACTERISTIC

public static final String SP_CHARACTERISTIC

Search parameter: characteristic

Description: One of the PractitionerRole's characteristics
Type: token
Path: PractitionerRole.characteristic

See Also:

• Constant Field Values

CHARACTERISTIC

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CHARACTERISTIC

Fluent Client search parameter constant for characteristic

Description: One of the PractitionerRole's characteristics
Type: token
Path: PractitionerRole.characteristic

SP_COMMUNICATION

public static final String SP_COMMUNICATION

Search parameter: communication

Description: One of the languages that the practitioner can communicate with
Type: token
Path: PractitionerRole.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: PractitionerRole.communication

SP_DATE

public static final String SP_DATE

Search parameter: date

Description: The period during which the practitioner is authorized to perform in these role(s)
Type: date
Path: PractitionerRole.period

See Also:

• Constant Field Values

DATE

public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE

Fluent Client search parameter constant for date

Description: The period during which the practitioner is authorized to perform in these role(s)
Type: date
Path: PractitionerRole.period

SP_ENDPOINT

public static final String SP_ENDPOINT

Search parameter: endpoint

Description: Technical endpoints providing access to services operated for the practitioner with this role
Type: reference
Path: PractitionerRole.endpoint

See Also:

• Constant Field Values

ENDPOINT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENDPOINT

Fluent Client search parameter constant for endpoint

Description: Technical endpoints providing access to services operated for the practitioner with this role
Type: reference
Path: PractitionerRole.endpoint

INCLUDE_ENDPOINT

public static final ca.uhn.fhir.model.api.Include INCLUDE_ENDPOINT

Constant for fluent queries to be used to add include statements. Specifies the path value of "PractitionerRole:endpoint".

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: A practitioner's Identifier
Type: token
Path: PractitionerRole.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: PractitionerRole.identifier

SP_LOCATION

public static final String SP_LOCATION

Search parameter: location

Description: One of the locations at which this practitioner provides care
Type: reference
Path: 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: PractitionerRole.location

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 "PractitionerRole:location".

SP_ORGANIZATION

public static final String SP_ORGANIZATION

Search parameter: organization

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

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: PractitionerRole.organization

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 "PractitionerRole:organization".

SP_PRACTITIONER

public static final String SP_PRACTITIONER

Search parameter: practitioner

Description: Practitioner that is able to provide the defined services for the organization
Type: reference
Path: PractitionerRole.practitioner

See Also:

• Constant Field Values

PRACTITIONER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PRACTITIONER

Fluent Client search parameter constant for practitioner

Description: Practitioner that is able to provide the defined services for the organization
Type: reference
Path: PractitionerRole.practitioner

INCLUDE_PRACTITIONER

public static final ca.uhn.fhir.model.api.Include INCLUDE_PRACTITIONER

Constant for fluent queries to be used to add include statements. Specifies the path value of "PractitionerRole:practitioner".

SP_ROLE

public static final String SP_ROLE

Search parameter: role

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

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: PractitionerRole.code

SP_SERVICE

public static final String SP_SERVICE

Search parameter: service

Description: The list of healthcare services that this worker provides for this role's Organization/Location(s)
Type: reference
Path: PractitionerRole.healthcareService

See Also:

• Constant Field Values

SERVICE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SERVICE

Fluent Client search parameter constant for service

Description: The list of healthcare services that this worker provides for this role's Organization/Location(s)
Type: reference
Path: PractitionerRole.healthcareService

INCLUDE_SERVICE

public static final ca.uhn.fhir.model.api.Include INCLUDE_SERVICE

Constant for fluent queries to be used to add include statements. Specifies the path value of "PractitionerRole:service".

SP_SPECIALTY

public static final String SP_SPECIALTY

Search parameter: specialty

Description: The practitioner has this specialty at an organization
Type: token
Path: 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: PractitionerRole.specialty

SP_EMAIL

public static final String SP_EMAIL

Search parameter: email

Description: Multiple Resources: [Patient](patient.html): A value in an email contact [Person](person.html): A value in an email contact [Practitioner](practitioner.html): A value in an email contact [PractitionerRole](practitionerrole.html): A value in an email contact [RelatedPerson](relatedperson.html): A value in an email contact
Type: token
Path: Patient.telecom.where(system='email') | Person.telecom.where(system='email') | Practitioner.telecom.where(system='email') | PractitionerRole.contact.telecom.where(system='email') | RelatedPerson.telecom.where(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: Multiple Resources: [Patient](patient.html): A value in an email contact [Person](person.html): A value in an email contact [Practitioner](practitioner.html): A value in an email contact [PractitionerRole](practitionerrole.html): A value in an email contact [RelatedPerson](relatedperson.html): A value in an email contact
Type: token
Path: Patient.telecom.where(system='email') | Person.telecom.where(system='email') | Practitioner.telecom.where(system='email') | PractitionerRole.contact.telecom.where(system='email') | RelatedPerson.telecom.where(system='email')

SP_PHONE

public static final String SP_PHONE

Search parameter: phone

Description: Multiple Resources: [Patient](patient.html): A value in a phone contact [Person](person.html): A value in a phone contact [Practitioner](practitioner.html): A value in a phone contact [PractitionerRole](practitionerrole.html): A value in a phone contact [RelatedPerson](relatedperson.html): A value in a phone contact
Type: token
Path: Patient.telecom.where(system='phone') | Person.telecom.where(system='phone') | Practitioner.telecom.where(system='phone') | PractitionerRole.contact.telecom.where(system='phone') | RelatedPerson.telecom.where(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: Multiple Resources: [Patient](patient.html): A value in a phone contact [Person](person.html): A value in a phone contact [Practitioner](practitioner.html): A value in a phone contact [PractitionerRole](practitionerrole.html): A value in a phone contact [RelatedPerson](relatedperson.html): A value in a phone contact
Type: token
Path: Patient.telecom.where(system='phone') | Person.telecom.where(system='phone') | Practitioner.telecom.where(system='phone') | PractitionerRole.contact.telecom.where(system='phone') | RelatedPerson.telecom.where(system='phone')

SP_TELECOM

public static final String SP_TELECOM

Search parameter: telecom

Description: Multiple Resources: [Patient](patient.html): The value in any kind of telecom details of the patient [Person](person.html): The value in any kind of contact [Practitioner](practitioner.html): The value in any kind of contact [PractitionerRole](practitionerrole.html): The value in any kind of contact [RelatedPerson](relatedperson.html): The value in any kind of contact
Type: token
Path: Patient.telecom | Person.telecom | Practitioner.telecom | PractitionerRole.contact.telecom | RelatedPerson.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: Multiple Resources: [Patient](patient.html): The value in any kind of telecom details of the patient [Person](person.html): The value in any kind of contact [Practitioner](practitioner.html): The value in any kind of contact [PractitionerRole](practitionerrole.html): The value in any kind of contact [RelatedPerson](relatedperson.html): The value in any kind of contact
Type: token
Path: Patient.telecom | Person.telecom | Practitioner.telecom | PractitionerRole.contact.telecom | RelatedPerson.telecom

Constructor Details

PractitionerRole

public PractitionerRole()

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (Business Identifiers that are specific to a role/location.)

setIdentifier

public PractitionerRole setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public PractitionerRole addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist {3}

getActiveElement

public BooleanType getActiveElement()

Returns:

active ( 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.). 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 PractitionerRole setActiveElement(BooleanType value)

Parameters:

value - active ( 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.). 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 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.

setActive

public PractitionerRole setActive(boolean value)

Parameters:

value - 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.

getPeriod

public Period getPeriod()

Returns:

period (The period during which the person is authorized to act as a practitioner in these role(s) for the organization.)

hasPeriod

public boolean hasPeriod()

setPeriod

public PractitionerRole setPeriod(Period value)

Parameters:

value - period (The period during which the person is authorized to act as a practitioner in these role(s) for the organization.)

getPractitioner

public Reference getPractitioner()

Returns:

practitioner (Practitioner that is able to provide the defined services for the organization.)

hasPractitioner

public boolean hasPractitioner()

setPractitioner

public PractitionerRole setPractitioner(Reference value)

Parameters:

value - practitioner (Practitioner that is able to provide the defined services for the organization.)

getOrganization

public Reference getOrganization()

Returns:

organization (The organization where the Practitioner performs the roles associated.)

hasOrganization

public boolean hasOrganization()

setOrganization

public PractitionerRole setOrganization(Reference value)

Parameters:

value - organization (The organization where the Practitioner performs the roles associated.)

getCode

public List<CodeableConcept> getCode()

Returns:

code (Roles which this practitioner is authorized to perform for the organization.)

setCode

public PractitionerRole setCode(List<CodeableConcept> theCode)

Returns:

Returns a reference to this for easy method chaining

hasCode

public boolean hasCode()

addCode

public CodeableConcept addCode()

addCode

public PractitionerRole addCode(CodeableConcept t)

getCodeFirstRep

public CodeableConcept getCodeFirstRep()

Returns:

The first repetition of repeating field code, creating it if it does not already exist {3}

getSpecialty

public List<CodeableConcept> getSpecialty()

Returns:

specialty (The specialty of a practitioner that describes the functional role they are practicing at a given organization or location.)

setSpecialty

public PractitionerRole setSpecialty(List<CodeableConcept> theSpecialty)

Returns:

Returns a reference to this for easy method chaining

hasSpecialty

public boolean hasSpecialty()

addSpecialty

public CodeableConcept addSpecialty()

addSpecialty

public PractitionerRole addSpecialty(CodeableConcept t)

getSpecialtyFirstRep

public CodeableConcept getSpecialtyFirstRep()

Returns:

The first repetition of repeating field specialty, creating it if it does not already exist {3}

getLocation

public List<Reference> getLocation()

Returns:

location (The location(s) at which this practitioner provides care.)

setLocation

public PractitionerRole setLocation(List<Reference> theLocation)

Returns:

Returns a reference to this for easy method chaining

hasLocation

public boolean hasLocation()

addLocation

public Reference addLocation()

addLocation

public PractitionerRole addLocation(Reference t)

getLocationFirstRep

public Reference getLocationFirstRep()

Returns:

The first repetition of repeating field location, creating it if it does not already exist {3}

getHealthcareService

public List<Reference> getHealthcareService()

Returns:

healthcareService (The list of healthcare services that this worker provides for this role's Organization/Location(s).)

setHealthcareService

public PractitionerRole setHealthcareService(List<Reference> theHealthcareService)

Returns:

Returns a reference to this for easy method chaining

hasHealthcareService

public boolean hasHealthcareService()

addHealthcareService

public Reference addHealthcareService()

addHealthcareService

public PractitionerRole addHealthcareService(Reference t)

getHealthcareServiceFirstRep

public Reference getHealthcareServiceFirstRep()

Returns:

The first repetition of repeating field healthcareService, creating it if it does not already exist {3}

getContact

public List<ExtendedContactDetail> getContact()

Returns:

contact (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.)

setContact

public PractitionerRole setContact(List<ExtendedContactDetail> theContact)

Returns:

Returns a reference to this for easy method chaining

hasContact

public boolean hasContact()

addContact

public ExtendedContactDetail addContact()

addContact

public PractitionerRole addContact(ExtendedContactDetail t)

getContactFirstRep

public ExtendedContactDetail getContactFirstRep()

Returns:

The first repetition of repeating field contact, creating it if it does not already exist {3}

getCharacteristic

public List<CodeableConcept> getCharacteristic()

Returns:

characteristic (Collection of characteristics (attributes).)

setCharacteristic

public PractitionerRole setCharacteristic(List<CodeableConcept> theCharacteristic)

Returns:

Returns a reference to this for easy method chaining

hasCharacteristic

public boolean hasCharacteristic()

addCharacteristic

public CodeableConcept addCharacteristic()

addCharacteristic

public PractitionerRole addCharacteristic(CodeableConcept t)

getCharacteristicFirstRep

public CodeableConcept getCharacteristicFirstRep()

Returns:

The first repetition of repeating field characteristic, creating it if it does not already exist {3}

getCommunication

public List<CodeableConcept> getCommunication()

Returns:

communication (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.)

setCommunication

public PractitionerRole setCommunication(List<CodeableConcept> theCommunication)

Returns:

Returns a reference to this for easy method chaining

hasCommunication

public boolean hasCommunication()

addCommunication

public CodeableConcept addCommunication()

addCommunication

public PractitionerRole addCommunication(CodeableConcept t)

getCommunicationFirstRep

public CodeableConcept getCommunicationFirstRep()

Returns:

The first repetition of repeating field communication, creating it if it does not already exist {3}

getAvailability

public List<Availability> getAvailability()

Returns:

availability (A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.)

setAvailability

public PractitionerRole setAvailability(List<Availability> theAvailability)

Returns:

Returns a reference to this for easy method chaining

hasAvailability

public boolean hasAvailability()

addAvailability

public Availability addAvailability()

addAvailability

public PractitionerRole addAvailability(Availability t)

getAvailabilityFirstRep

public Availability getAvailabilityFirstRep()

Returns:

The first repetition of repeating field availability, creating it if it does not already exist {3}

getEndpoint

public List<Reference> getEndpoint()

Returns:

endpoint ( 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.)

setEndpoint

public PractitionerRole setEndpoint(List<Reference> theEndpoint)

Returns:

Returns a reference to this for easy method chaining

hasEndpoint

public boolean hasEndpoint()

addEndpoint

public Reference addEndpoint()

addEndpoint

public PractitionerRole addEndpoint(Reference t)

getEndpointFirstRep

public Reference getEndpointFirstRep()

Returns:

The first repetition of repeating field endpoint, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

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 class DomainResource

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 class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty 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()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

Returns:

the FHIR type name of the instance (not the java class name)

copy

public PractitionerRole copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(PractitionerRole dst)

typedCopy

protected PractitionerRole 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