The Practitioner resource implements the FHIR R4 Practitioner specification and US Core v3.1.1 Practitioner profile

Fields

Name Type Cardinality Required Description
identifier Identifier 0..*   A identifier for the person as this agent (see Profiles for details)
active boolean 0..1   Whether this practitioner’s record is in active use
name HumanName 1..*   The name(s) associated with the practitioner
name.family string 1..1 * Family name (often called ‘Surname’)
telecom ContactPoint 0..*   A contact detail for the practitioner (that apply to all roles)
address Address 0..*   Address(es) of the practitioner that are not role specific (typically home address)
gender code 0..1   male | female | other | unknown
birthDate date 0..1   The date on which the practitioner was born
photo Attachment 0..*   Image of the person
qualification BackboneElement 0..*   Qualifications obtained by training and certification
communication CodeableConcept 0..*   A language the practitioner is able to use in patient communication

Interactions

Read

Get an Practitioner entry by id

GET /Practitioner/:id

Example

Request

https://r4cert.medicasoft.us/api/fhir/Practitioner/e8329507-747c-301b-b16a-dc5e163ed791

Response

{
  "resourceType": "Practitioner",
  "identifier": [
    {
      "value": "9999995639",
      "system": "http://hl7.org/fhir/sid/us-npi"
    }
  ],
  "active": true,
  "name": [
    {
      "family": "Huels583",
      "given": [
        "Titus37"
      ],
      "prefix": [
        "Dr."
      ]
    }
  ],
  "telecom": [
    {
      "extension": [
        {
          "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-direct",
          "valueBoolean": true
        }
      ],
      "system": "email",
      "value": "Titus37.Huels583@example.com",
      "use": "work"
    }
  ],
  "address": [
    {
      "line": [
        "68 EVERGREEN ST"
      ],
      "city": "KINGSTON",
      "state": "MA",
      "country": "US",
      "postalCode": "02364-1471"
    }
  ],
  "gender": "male",
  "id": "e8329507-747c-301b-b16a-dc5e163ed791"
}

Query Practitioner resources

GET /Practitioner?:query_parameters

Parameters

Name Type Description
identifier token A practitioner’s Identifier
given string A portion of the given name
address string A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text
address-state string A state specified in an address
gender token Gender of the practitioner
active token Whether the practitioner record is active
address-postalcode string A postalCode specified in an address
name string A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
telecom token The value in any kind of contact
family string A portion of the family name
address-city string A city specified in an address
_revinclude   Provenance:target

Errors

Code Description
400 Invalid parameters
404 Resource not found

Profiles

Per the US Core profile a Prcatitioner NPI identifier should be coded using the following system value:

  • NPI: http://hl7.org/fhir/sid/us-npi