Skip to main content

Practitioner

Overview​

The Practitioner resource provides information about a person who is directly or indirectly involved in the provisioning of healthcare. This resource represents healthcare providers, clinicians, and other care team members.

Use Cases:

  • Identify healthcare providers
  • Track care team members
  • Reference practitioners in other resources

Relationships:

  • Referenced by other resources (Encounter, Observation, etc.)
  • May include Provenance information

Resource Schema​

Key fields in the Practitioner resource:

{
  "resourceType": "Practitioner",
  "id": "example-practitioner",
  "identifier": [{
    "system": "http://hl7.org/fhir/sid/us-npi",
    "value": "1234567890"
  }],
  "name": [{
    "family": "Smith",
    "given": ["John"],
    "prefix": ["Dr."]
  }],
  "qualification": [{
    "code": {
      "coding": [{
        "system": "http://terminology.hl7.org/CodeSystem/v2-0360",
        "code": "MD",
        "display": "Doctor of Medicine"
      }]
    }
  }]
}

Operations​

The Certified API Practitioner resource supports the following standard operations. However, support varies by the targeted CareRecord or solution.

CareRecord / SolutionCreateReadUpdateSearch
GEHRIMED-Yes-Yes
myAvatar-Yes-Yes
myEvolv-Yes-Yes
myUnity-Yes-Yes
TheraOffice-Yes-Yes

Read​

Retrieve a specific Practitioner resource by its ID.

info

Not all Netsmart solutions support Practitioner search. See supported operations table above and consult your target solution's documentation for more information.

Search for practitioners using various criteria.

GET Method​

Use GET for simple searches with parameters in the query string.

GET /Practitioner?parameter=value

POST Method​

Use POST for complex searches with form-encoded parameters.

POST /Practitioner/_search

Search Parameters​

Search Parameters:

ParameterTypeRequiredDescriptionExample
familystringNoA portion of the family namefamily=value
givenstringNoA portion of the given namegiven=value
identifiertokenNoA practitioner's Identifieridentifier=value
namestringNoA server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or textname=value
_lastUpdateddateNoOnly return resources which were last updated as specified by the given range_lastUpdated=value
_revincludespecialNoInclude Provenance resource(s) that reference the matched search results. Allowed: "Provenance:target"_revinclude=value
_idstringYesThe ID of the resource_id=value

Examples​

Read Request​

Read Practitioner
curl -X GET "https://fhir.netsmartcloud.com/provider/patient-access/v2/{tenant-id}/Practitioner/example-practitioner" \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json"

Common Search Patterns​

Find practitioners by name:

GET /Practitioner?name=Smith&_count=10

Search by family name:

GET /Practitioner?family=Johnson

Find by identifier:

GET /Practitioner?identifier=1234567890

Search by given name:

GET /Practitioner?given=John

Request Examples​

Search by Name
curl -X POST https://fhir.netsmartcloud.com/provider/patient-access/v2/{tenant-id}/Practitioner/_search \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-www-form-urlencoded" \
    -d "name=Smith"
Search by identifier
curl -X GET "https://fhir.netsmartcloud.com/provider/patient-access/v2/{tenant-id}/Practitioner?identifier=1234567890" \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json"

Integration Patterns​

Common Workflows​

  1. Provider Lookup: Search for practitioners by name or identifier
  2. Care Team Assembly: Reference practitioners in care plans and encounters
  3. Provider Directory: Maintain directory of healthcare providers
  • Encounter: References the attending practitioner
  • Observation: May reference the performing practitioner
  • PractitionerRole: Defines roles and locations for the practitioner
  • Provenance: Audit trail information

Error Handling​

For detailed error codes and handling, see the Error Handling documentation.

Supported Profiles​

This API supports the following FHIR profiles: