Class PractitionerRole
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.PractitionerRole
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") 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.Maturity level: FMM2 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PractitionerRole.AvailableTime
A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.static class
PractitionerRole.Builder
static class
PractitionerRole.NotAvailable
The practitioner is not available or performing this role during this period of time due to the provided reason.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static PractitionerRole.Builder
builder()
boolean
equals(java.lang.Object obj)
Boolean
getActive()
Whether this practitioner role record is in active use.String
getAvailabilityExceptions()
A description of site availability exceptions, e.g.java.util.List<PractitionerRole.AvailableTime>
getAvailableTime()
A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.java.util.List<CodeableConcept>
getCode()
Roles which this practitioner is authorized to perform for the organization.java.util.List<Reference>
getEndpoint()
Technical endpoints providing access to services operated for the practitioner with this role.java.util.List<Reference>
getHealthcareService()
The list of healthcare services that this worker provides for this role's Organization/Location(s).java.util.List<Identifier>
getIdentifier()
Business Identifiers that are specific to a role/location.java.util.List<Reference>
getLocation()
The location(s) at which this practitioner provides care.java.util.List<PractitionerRole.NotAvailable>
getNotAvailable()
The practitioner is not available or performing this role during this period of time due to the provided reason.Reference
getOrganization()
The organization where the Practitioner performs the roles associated.Period
getPeriod()
The period during which the person is authorized to act as a practitioner in these role(s) for the organization.Reference
getPractitioner()
Practitioner that is able to provide the defined services for the organization.java.util.List<CodeableConcept>
getSpecialty()
Specific specialty of the practitioner.java.util.List<ContactPoint>
getTelecom()
Contact details that are specific to the role/location/service.boolean
hasChildren()
int
hashCode()
PractitionerRole.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public java.util.List<Identifier> getIdentifier()
Business Identifiers that are specific to a role/location.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getActive
public Boolean getActive()
Whether this practitioner role record is in active use.- Returns:
- An immutable object of type
Boolean
that may be null.
-
getPeriod
public Period getPeriod()
The period during which the person is authorized to act as a practitioner in these role(s) for the organization.- Returns:
- An immutable object of type
Period
that may be null.
-
getPractitioner
public Reference getPractitioner()
Practitioner that is able to provide the defined services for the organization.- Returns:
- An immutable object of type
Reference
that may be null.
-
getOrganization
public Reference getOrganization()
The organization where the Practitioner performs the roles associated.- Returns:
- An immutable object of type
Reference
that may be null.
-
getCode
public java.util.List<CodeableConcept> getCode()
Roles which this practitioner is authorized to perform for the organization.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getSpecialty
public java.util.List<CodeableConcept> getSpecialty()
Specific specialty of the practitioner.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getLocation
public java.util.List<Reference> getLocation()
The location(s) at which this practitioner provides care.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getHealthcareService
public java.util.List<Reference> getHealthcareService()
The list of healthcare services that this worker provides for this role's Organization/Location(s).- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getTelecom
public java.util.List<ContactPoint> getTelecom()
Contact details that are specific to the role/location/service.- Returns:
- An unmodifiable list containing immutable objects of type
ContactPoint
that may be empty.
-
getAvailableTime
public java.util.List<PractitionerRole.AvailableTime> getAvailableTime()
A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.- Returns:
- An unmodifiable list containing immutable objects of type
PractitionerRole.AvailableTime
that may be empty.
-
getNotAvailable
public java.util.List<PractitionerRole.NotAvailable> getNotAvailable()
The practitioner is not available or performing this role during this period of time due to the provided reason.- Returns:
- An unmodifiable list containing immutable objects of type
PractitionerRole.NotAvailable
that may be empty.
-
getAvailabilityExceptions
public String getAvailabilityExceptions()
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.- Returns:
- An immutable object of type
String
that may be null.
-
getEndpoint
public java.util.List<Reference> getEndpoint()
Technical endpoints providing access to services operated for the practitioner with this role.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public PractitionerRole.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static PractitionerRole.Builder builder()
-
-