Class 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:
  • Field Details

    • 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

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

      The organization where the Practitioner performs the roles associated.
    • code

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

      Specific specialty of the practitioner.
    • location

      protected List<Reference> location
      The location(s) at which this practitioner provides care.
    • healthcareService

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

      Contact details that are specific to the role/location/service.
    • availableTime

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

      The practitioner is not available or performing this role during this period of time due to the provided reason.
    • 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.
    • 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:
    • 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_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:
    • 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:
    • 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:
    • 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:
    • 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:
    • 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:
    • 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:
    • 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:
    • 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:
    • 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.telecom.where(system='email') | RelatedPerson.telecom.where(system='email')

      See Also:
    • 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.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.telecom.where(system='phone') | RelatedPerson.telecom.where(system='phone')

      See Also:
    • 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.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.telecom | RelatedPerson.telecom

      See Also:
    • 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.telecom | RelatedPerson.telecom

  • Constructor Details

  • Method Details