PractitionerRole (org.hl7.fhir.r4 5.4.0 API)

java.lang.Object
- org.hl7.fhir.r4.model.Base
- - org.hl7.fhir.r4.model.BaseResource
  - - org.hl7.fhir.r4.model.Resource
    - - org.hl7.fhir.r4.model.DomainResource
      - org.hl7.fhir.r4.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 at an organization for a period of time.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PractitionerRole.DaysOfWeek`
`static class`	`PractitionerRole.DaysOfWeekEnumFactory`
`static class`	`PractitionerRole.PractitionerRoleAvailableTimeComponent`
`static class`	`PractitionerRole.PractitionerRoleNotAvailableComponent`

Field Summary

Fields
Modifier and Type	Field and Description
`protected BooleanType`	`active` Whether this practitioner role record is in active use.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`ACTIVE` Fluent Client search parameter constant for active
`protected StringType`	`availabilityExceptions` A description of site availability exceptions, e.g.
`protected List<PractitionerRole.PractitionerRoleAvailableTimeComponent>`	`availableTime` A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
`protected List<CodeableConcept>`	`code` Roles which this practitioner is authorized to perform for the organization.
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`DATE` Fluent Client search parameter constant for date
`static 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 ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`ENDPOINT` Fluent Client search parameter constant for endpoint
`protected List<Endpoint>`	`endpointTarget` The actual objects that are the target of the reference (Technical endpoints providing access to services operated for the practitioner with this role.)
`protected List<Reference>`	`healthcareService` The list of healthcare services that this worker provides for this role's Organization/Location(s).
`protected List<HealthcareService>`	`healthcareServiceTarget` The actual objects that are the target of the reference (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 ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_ENDPOINT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_LOCATION` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_ORGANIZATION` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PRACTITIONER` Constant for fluent queries to be used to add include statements.
`static 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 ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`LOCATION` Fluent Client search parameter constant for location
`protected List<Location>`	`locationTarget` The actual objects that are the target of the reference (The location(s) at which this practitioner provides care.)
`protected List<PractitionerRole.PractitionerRoleNotAvailableComponent>`	`notAvailable` The practitioner is not available or performing this role during this period of time due to the provided reason.
`protected Reference`	`organization` The organization where the Practitioner performs the roles associated.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`ORGANIZATION` Fluent Client search parameter constant for organization
`protected Organization`	`organizationTarget` The actual object that is the target of the reference (The organization where the Practitioner performs the roles associated.)
`protected Period`	`period` The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
`static 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 ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PRACTITIONER` Fluent Client search parameter constant for practitioner
`protected Practitioner`	`practitionerTarget` The actual object that is the target of the reference (Practitioner that is able to provide the defined services for the organization.)
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`ROLE` Fluent Client search parameter constant for role
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`SERVICE` Fluent Client search parameter constant for service
`static String`	`SP_ACTIVE` Search parameter: active
`static String`	`SP_DATE` Search parameter: date
`static String`	`SP_EMAIL` Search parameter: email
`static String`	`SP_ENDPOINT` Search parameter: endpoint
`static String`	`SP_IDENTIFIER` Search parameter: identifier
`static String`	`SP_LOCATION` Search parameter: location
`static String`	`SP_ORGANIZATION` Search parameter: organization
`static String`	`SP_PHONE` Search parameter: phone
`static String`	`SP_PRACTITIONER` Search parameter: practitioner
`static String`	`SP_ROLE` Search parameter: role
`static String`	`SP_SERVICE` Search parameter: service
`static String`	`SP_SPECIALTY` Search parameter: specialty
`static String`	`SP_TELECOM` Search parameter: telecom
`protected List<CodeableConcept>`	`specialty` Specific specialty of the practitioner.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`SPECIALTY` Fluent Client search parameter constant for specialty
`protected List<ContactPoint>`	`telecom` Contact details that are specific to the role/location/service.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`TELECOM` Fluent Client search parameter constant for telecom

Fields 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, 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

PractitionerRole()
Constructor

Constructors
Constructor and Description
`PractitionerRole()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`PractitionerRole.PractitionerRoleAvailableTimeComponent`	`addAvailableTime()`
`PractitionerRole`	`addAvailableTime(PractitionerRole.PractitionerRoleAvailableTimeComponent t)`
`Base`	`addChild(String name)`
`CodeableConcept`	`addCode()`
`PractitionerRole`	`addCode(CodeableConcept t)`
`Reference`	`addEndpoint()`
`PractitionerRole`	`addEndpoint(Reference t)`
`Endpoint`	`addEndpointTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`Reference`	`addHealthcareService()`
`PractitionerRole`	`addHealthcareService(Reference t)`
`HealthcareService`	`addHealthcareServiceTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`Identifier`	`addIdentifier()`
`PractitionerRole`	`addIdentifier(Identifier t)`
`Reference`	`addLocation()`
`PractitionerRole`	`addLocation(Reference t)`
`Location`	`addLocationTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`PractitionerRole.PractitionerRoleNotAvailableComponent`	`addNotAvailable()`
`PractitionerRole`	`addNotAvailable(PractitionerRole.PractitionerRoleNotAvailableComponent t)`
`CodeableConcept`	`addSpecialty()`
`PractitionerRole`	`addSpecialty(CodeableConcept t)`
`ContactPoint`	`addTelecom()`
`PractitionerRole`	`addTelecom(ContactPoint t)`
`PractitionerRole`	`copy()`
`void`	`copyValues(PractitionerRole dst)`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`boolean`	`getActive()`
`BooleanType`	`getActiveElement()`
`String`	`getAvailabilityExceptions()`
`StringType`	`getAvailabilityExceptionsElement()`
`List<PractitionerRole.PractitionerRoleAvailableTimeComponent>`	`getAvailableTime()`
`PractitionerRole.PractitionerRoleAvailableTimeComponent`	`getAvailableTimeFirstRep()`
`List<CodeableConcept>`	`getCode()`
`CodeableConcept`	`getCodeFirstRep()`
`List<Reference>`	`getEndpoint()`
`Reference`	`getEndpointFirstRep()`
`List<Endpoint>`	`getEndpointTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`List<Reference>`	`getHealthcareService()`
`Reference`	`getHealthcareServiceFirstRep()`
`List<HealthcareService>`	`getHealthcareServiceTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`List<Identifier>`	`getIdentifier()`
`Identifier`	`getIdentifierFirstRep()`
`List<Reference>`	`getLocation()`
`Reference`	`getLocationFirstRep()`
`List<Location>`	`getLocationTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`List<PractitionerRole.PractitionerRoleNotAvailableComponent>`	`getNotAvailable()`
`PractitionerRole.PractitionerRoleNotAvailableComponent`	`getNotAvailableFirstRep()`
`Reference`	`getOrganization()`
`Organization`	`getOrganizationTarget()`
`Period`	`getPeriod()`
`Reference`	`getPractitioner()`
`Practitioner`	`getPractitionerTarget()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`ResourceType`	`getResourceType()`
`List<CodeableConcept>`	`getSpecialty()`
`CodeableConcept`	`getSpecialtyFirstRep()`
`List<ContactPoint>`	`getTelecom()`
`ContactPoint`	`getTelecomFirstRep()`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasActive()`
`boolean`	`hasActiveElement()`
`boolean`	`hasAvailabilityExceptions()`
`boolean`	`hasAvailabilityExceptionsElement()`
`boolean`	`hasAvailableTime()`
`boolean`	`hasCode()`
`boolean`	`hasEndpoint()`
`boolean`	`hasHealthcareService()`
`boolean`	`hasIdentifier()`
`boolean`	`hasLocation()`
`boolean`	`hasNotAvailable()`
`boolean`	`hasOrganization()`
`boolean`	`hasPeriod()`
`boolean`	`hasPractitioner()`
`boolean`	`hasSpecialty()`
`boolean`	`hasTelecom()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`PractitionerRole`	`setActive(boolean value)`
`PractitionerRole`	`setActiveElement(BooleanType value)`
`PractitionerRole`	`setAvailabilityExceptions(String value)`
`PractitionerRole`	`setAvailabilityExceptionsElement(StringType value)`
`PractitionerRole`	`setAvailableTime(List<PractitionerRole.PractitionerRoleAvailableTimeComponent> theAvailableTime)`
`PractitionerRole`	`setCode(List<CodeableConcept> theCode)`
`PractitionerRole`	`setEndpoint(List<Reference> theEndpoint)`
`PractitionerRole`	`setHealthcareService(List<Reference> theHealthcareService)`
`PractitionerRole`	`setIdentifier(List<Identifier> theIdentifier)`
`PractitionerRole`	`setLocation(List<Reference> theLocation)`
`PractitionerRole`	`setNotAvailable(List<PractitionerRole.PractitionerRoleNotAvailableComponent> theNotAvailable)`
`PractitionerRole`	`setOrganization(Reference value)`
`PractitionerRole`	`setOrganizationTarget(Organization value)`
`PractitionerRole`	`setPeriod(Period value)`
`PractitionerRole`	`setPractitioner(Reference value)`
`PractitionerRole`	`setPractitionerTarget(Practitioner value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`PractitionerRole`	`setSpecialty(List<CodeableConcept> theSpecialty)`
`PractitionerRole`	`setTelecom(List<ContactPoint> theTelecom)`
`protected PractitionerRole`	`typedCopy()`

Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, 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, 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, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, 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.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
```
    Business Identifiers that are specific to a role/location.
  - active
```
protected BooleanType active
```
    Whether this practitioner role record is in active use.
  - 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.
  - practitionerTarget
```
protected Practitioner practitionerTarget
```
    The actual object that is the target of the reference (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.
  - organizationTarget
```
protected Organization organizationTarget
```
    The actual object that is the target of the reference (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
```
    Specific specialty of the practitioner.
  - location
```
protected List<Reference> location
```
    The location(s) at which this practitioner provides care.
  - locationTarget
```
protected List<Location> locationTarget
```
    The actual objects that are the target of the reference (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).
  - healthcareServiceTarget
```
protected List<HealthcareService> healthcareServiceTarget
```
    The actual objects that are the target of the reference (The list of healthcare services that this worker provides for this role's Organization/Location(s).)
  - telecom
```
protected List<ContactPoint> telecom
```
    Contact details that are specific to the role/location/service.
  - availableTime
```
protected List<PractitionerRole.PractitionerRoleAvailableTimeComponent> availableTime
```
    A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
  - notAvailable
```
protected List<PractitionerRole.PractitionerRoleNotAvailableComponent> notAvailable
```
    The practitioner is not available or performing this role during this period of time due to the provided reason.
  - availabilityExceptions
```
protected StringType availabilityExceptions
```
    A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
  - endpoint
```
protected List<Reference> endpoint
```
    Technical endpoints providing access to services operated for the practitioner with this role.
  - endpointTarget
```
protected List<Endpoint> endpointTarget
```
    The actual objects that are the target of the reference (Technical endpoints providing access to services operated for the practitioner with this role.)
  - 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_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_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_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_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_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_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_PHONE
```
public static final String SP_PHONE
```
    Search parameter: phone
    Description: A value in a phone contact
    Type: token
    Path: PractitionerRole.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: PractitionerRole.telecom(system=phone)
  - 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_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_TELECOM
```
public static final String SP_TELECOM
```
    Search parameter: telecom
    Description: The value in any kind of contact
    Type: token
    Path: PractitionerRole.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: PractitionerRole.telecom
  - 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_EMAIL
```
public static final String SP_EMAIL
```
    Search parameter: email
    Description: A value in an email contact
    Type: token
    Path: PractitionerRole.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: PractitionerRole.telecom(system=email)
- Constructor Detail
  - PractitionerRole
```
public PractitionerRole()
```
    Constructor
- Method Detail
  - 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
  - getActiveElement
```
public BooleanType getActiveElement()
```
    Returns:
    
    active (Whether this practitioner role 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 PractitionerRole setActiveElement(BooleanType value)
```
    Parameters:
    
    value - active (Whether this practitioner role 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 role record is in active use.
  - setActive
```
public PractitionerRole setActive(boolean value)
```
    Parameters:
    
    value - Whether this practitioner role record is in active use.
  - 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.)
  - getPractitionerTarget
```
public Practitioner getPractitionerTarget()
```
    Returns:
    
    practitioner The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Practitioner that is able to provide the defined services for the organization.)
  - setPractitionerTarget
```
public PractitionerRole setPractitionerTarget(Practitioner value)
```
    Parameters:
    
    value - practitioner The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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.)
  - getOrganizationTarget
```
public Organization getOrganizationTarget()
```
    Returns:
    
    organization The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The organization where the Practitioner performs the roles associated.)
  - setOrganizationTarget
```
public PractitionerRole setOrganizationTarget(Organization value)
```
    Parameters:
    
    value - organization The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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
  - getSpecialty
```
public List<CodeableConcept> getSpecialty()
```
    Returns:
    
    specialty (Specific specialty of the practitioner.)
  - 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
  - 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
  - getLocationTarget
```
@Deprecated
public List<Location> getLocationTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - addLocationTarget
```
@Deprecated
public Location addLocationTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - 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
  - getHealthcareServiceTarget
```
@Deprecated
public List<HealthcareService> getHealthcareServiceTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - addHealthcareServiceTarget
```
@Deprecated
public HealthcareService addHealthcareServiceTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - getTelecom
```
public List<ContactPoint> getTelecom()
```
    Returns:
    
    telecom (Contact details that are specific to the role/location/service.)
  - setTelecom
```
public PractitionerRole setTelecom(List<ContactPoint> theTelecom)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasTelecom
```
public boolean hasTelecom()
```
  - addTelecom
```
public ContactPoint addTelecom()
```
  - addTelecom
```
public PractitionerRole addTelecom(ContactPoint t)
```
  - getTelecomFirstRep
```
public ContactPoint getTelecomFirstRep()
```
    Returns:
    
    The first repetition of repeating field telecom, creating it if it does not already exist
  - getAvailableTime
```
public List<PractitionerRole.PractitionerRoleAvailableTimeComponent> getAvailableTime()
```
    Returns:
    
    availableTime (A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.)
  - setAvailableTime
```
public PractitionerRole setAvailableTime(List<PractitionerRole.PractitionerRoleAvailableTimeComponent> theAvailableTime)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasAvailableTime
```
public boolean hasAvailableTime()
```
  - addAvailableTime
```
public PractitionerRole.PractitionerRoleAvailableTimeComponent addAvailableTime()
```
  - addAvailableTime
```
public PractitionerRole addAvailableTime(PractitionerRole.PractitionerRoleAvailableTimeComponent t)
```
  - getAvailableTimeFirstRep
```
public PractitionerRole.PractitionerRoleAvailableTimeComponent getAvailableTimeFirstRep()
```
    Returns:
    
    The first repetition of repeating field availableTime, creating it if it does not already exist
  - getNotAvailable
```
public List<PractitionerRole.PractitionerRoleNotAvailableComponent> getNotAvailable()
```
    Returns:
    
    notAvailable (The practitioner is not available or performing this role during this period of time due to the provided reason.)
  - setNotAvailable
```
public PractitionerRole setNotAvailable(List<PractitionerRole.PractitionerRoleNotAvailableComponent> theNotAvailable)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasNotAvailable
```
public boolean hasNotAvailable()
```
  - addNotAvailable
```
public PractitionerRole.PractitionerRoleNotAvailableComponent addNotAvailable()
```
  - addNotAvailable
```
public PractitionerRole addNotAvailable(PractitionerRole.PractitionerRoleNotAvailableComponent t)
```
  - getNotAvailableFirstRep
```
public PractitionerRole.PractitionerRoleNotAvailableComponent getNotAvailableFirstRep()
```
    Returns:
    
    The first repetition of repeating field notAvailable, creating it if it does not already exist
  - getAvailabilityExceptionsElement
```
public StringType getAvailabilityExceptionsElement()
```
    Returns:
    
    availabilityExceptions (A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.). This is the underlying object with id, value and extensions. The accessor "getAvailabilityExceptions" gives direct access to the value
  - hasAvailabilityExceptionsElement
```
public boolean hasAvailabilityExceptionsElement()
```
  - hasAvailabilityExceptions
```
public boolean hasAvailabilityExceptions()
```
  - setAvailabilityExceptionsElement
```
public PractitionerRole setAvailabilityExceptionsElement(StringType value)
```
    Parameters:
    
    value - availabilityExceptions (A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.). This is the underlying object with id, value and extensions. The accessor "getAvailabilityExceptions" gives direct access to the value
  - getAvailabilityExceptions
```
public String getAvailabilityExceptions()
```
    Returns:
    
    A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
  - setAvailabilityExceptions
```
public PractitionerRole setAvailabilityExceptions(String value)
```
    Parameters:
    
    value - A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
  - getEndpoint
```
public List<Reference> getEndpoint()
```
    Returns:
    
    endpoint (Technical endpoints providing access to services operated for the practitioner with this role.)
  - 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
  - getEndpointTarget
```
@Deprecated
public List<Endpoint> getEndpointTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - addEndpointTarget
```
@Deprecated
public Endpoint addEndpointTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - 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
  - 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
  - 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

Class PractitionerRole

Nested Class Summary

Field Summary

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

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

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

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

Methods inherited from class org.hl7.fhir.r4.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

period

practitioner

practitionerTarget

organization

organizationTarget

code

specialty

location

locationTarget

healthcareService

healthcareServiceTarget

telecom

availableTime

notAvailable

availabilityExceptions

endpoint

endpointTarget

SP_DATE

DATE

SP_IDENTIFIER

IDENTIFIER

SP_SPECIALTY

SPECIALTY

SP_ROLE

ROLE

SP_PRACTITIONER

PRACTITIONER

INCLUDE_PRACTITIONER

SP_ACTIVE

ACTIVE

SP_ENDPOINT

ENDPOINT

INCLUDE_ENDPOINT

SP_PHONE

PHONE

SP_SERVICE

SERVICE

INCLUDE_SERVICE

SP_ORGANIZATION

ORGANIZATION

INCLUDE_ORGANIZATION

SP_TELECOM

TELECOM

SP_LOCATION

LOCATION

INCLUDE_LOCATION

SP_EMAIL

EMAIL

Constructor Detail

PractitionerRole

Method Detail

getIdentifier

setIdentifier

hasIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getActiveElement

hasActiveElement

hasActive