Class Practitioner

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

    public class Practitioner
    extends DomainResource
    A person who is directly or indirectly involved in the provisioning of healthcare.
    See Also:
    Serialized Form
    • Field Detail

      • active

        protected BooleanType active
        Whether this practitioner's record is in active use.
      • telecom

        protected List<ContactPoint> telecom
        A contact detail for the practitioner, e.g. a telephone number or an email address.
      • address

        protected List<Address> address
        Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.
      • SP_PHONE

        public static final String SP_PHONE
        Search parameter: phone

        Description: A value in a phone contact
        Type: token
        Path: Practitioner.telecom(system=phone), Practitioner.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: Practitioner.telecom(system=phone), Practitioner.practitionerRole.telecom(system=phone)

      • SP_PHONETIC

        public static final String SP_PHONETIC
        Search parameter: phonetic

        Description: A portion of either family or given name using some kind of phonetic matching algorithm
        Type: string
        Path: Practitioner.name

        See Also:
        Constant Field Values
      • PHONETIC

        public static final ca.uhn.fhir.rest.gclient.StringClientParam PHONETIC
        Fluent Client search parameter constant for phonetic

        Description: A portion of either family or given name using some kind of phonetic matching algorithm
        Type: string
        Path: Practitioner.name

      • 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: Practitioner.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: Practitioner.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 "Practitioner:location".
      • 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: Practitioner.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: Practitioner.communication

      • SP_ADDRESS_COUNTRY

        public static final String SP_ADDRESS_COUNTRY
        Search parameter: address-country

        Description: A country specified in an address
        Type: string
        Path: Practitioner.address.country

        See Also:
        Constant Field Values
      • ADDRESS_COUNTRY

        public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_COUNTRY
        Fluent Client search parameter constant for address-country

        Description: A country specified in an address
        Type: string
        Path: Practitioner.address.country

      • 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: Practitioner.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: Practitioner.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 "Practitioner:organization".
      • SP_ADDRESS_CITY

        public static final String SP_ADDRESS_CITY
        Search parameter: address-city

        Description: A city specified in an address
        Type: string
        Path: Practitioner.address.city

        See Also:
        Constant Field Values
      • ADDRESS_CITY

        public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_CITY
        Fluent Client search parameter constant for address-city

        Description: A city specified in an address
        Type: string
        Path: Practitioner.address.city

      • SP_ADDRESS_STATE

        public static final String SP_ADDRESS_STATE
        Search parameter: address-state

        Description: A state specified in an address
        Type: string
        Path: Practitioner.address.state

        See Also:
        Constant Field Values
      • ADDRESS_STATE

        public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_STATE
        Fluent Client search parameter constant for address-state

        Description: A state specified in an address
        Type: string
        Path: Practitioner.address.state

      • SP_GIVEN

        public static final String SP_GIVEN
        Search parameter: given

        Description: A portion of the given name
        Type: string
        Path: Practitioner.name.given

        See Also:
        Constant Field Values
      • GIVEN

        public static final ca.uhn.fhir.rest.gclient.StringClientParam GIVEN
        Fluent Client search parameter constant for given

        Description: A portion of the given name
        Type: string
        Path: Practitioner.name.given

      • SP_EMAIL

        public static final String SP_EMAIL
        Search parameter: email

        Description: A value in an email contact
        Type: token
        Path: Practitioner.telecom(system=email), Practitioner.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: Practitioner.telecom(system=email), Practitioner.practitionerRole.telecom(system=email)

      • SP_ADDRESS

        public static final String SP_ADDRESS
        Search parameter: address

        Description: An address in any kind of address/part
        Type: string
        Path: Practitioner.address

        See Also:
        Constant Field Values
      • ADDRESS

        public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS
        Fluent Client search parameter constant for address

        Description: An address in any kind of address/part
        Type: string
        Path: Practitioner.address

      • SP_ADDRESS_USE

        public static final String SP_ADDRESS_USE
        Search parameter: address-use

        Description: A use code specified in an address
        Type: token
        Path: Practitioner.address.use

        See Also:
        Constant Field Values
      • ADDRESS_USE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam ADDRESS_USE
        Fluent Client search parameter constant for address-use

        Description: A use code specified in an address
        Type: token
        Path: Practitioner.address.use

      • SP_FAMILY

        public static final String SP_FAMILY
        Search parameter: family

        Description: A portion of the family name
        Type: string
        Path: Practitioner.name.family

        See Also:
        Constant Field Values
      • FAMILY

        public static final ca.uhn.fhir.rest.gclient.StringClientParam FAMILY
        Fluent Client search parameter constant for family

        Description: A portion of the family name
        Type: string
        Path: Practitioner.name.family

      • SP_NAME

        public static final String SP_NAME
        Search parameter: name

        Description: A portion of either family or given name
        Type: string
        Path: Practitioner.name

        See Also:
        Constant Field Values
      • NAME

        public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
        Fluent Client search parameter constant for name

        Description: A portion of either family or given name
        Type: string
        Path: Practitioner.name

      • SP_TELECOM

        public static final String SP_TELECOM
        Search parameter: telecom

        Description: The value in any kind of contact
        Type: token
        Path: Practitioner.telecom, Practitioner.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: Practitioner.telecom, Practitioner.practitionerRole.telecom

      • 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: Practitioner.practitionerRole.role

        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: Practitioner.practitionerRole.role

      • SP_GENDER

        public static final String SP_GENDER
        Search parameter: gender

        Description: Gender of the practitioner
        Type: token
        Path: Practitioner.gender

        See Also:
        Constant Field Values
      • GENDER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam GENDER
        Fluent Client search parameter constant for gender

        Description: Gender of the practitioner
        Type: token
        Path: Practitioner.gender

      • SP_SPECIALTY

        public static final String SP_SPECIALTY
        Search parameter: specialty

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

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

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

      • SP_ADDRESS_POSTALCODE

        public static final String SP_ADDRESS_POSTALCODE
        Search parameter: address-postalcode

        Description: A postalCode specified in an address
        Type: string
        Path: Practitioner.address.postalCode

        See Also:
        Constant Field Values
      • ADDRESS_POSTALCODE

        public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_POSTALCODE
        Fluent Client search parameter constant for address-postalcode

        Description: A postalCode specified in an address
        Type: string
        Path: Practitioner.address.postalCode