Practitioner - FHIR Resource (r4)

This Practitioner Resource uses the FHIR API standard for access and structure.

Validate an Practitioner FHIR Resource (r4)

Practitioner Attributes

AttributeField is listTypeDescription

Description: An identifier for the person as this agent

FHIR Version: r4

Attribute Type : Identifier

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier": [
  {
    "system": "http://www.acme.org/practitioners",
    "value": "23"
  }
]

Learn more about the (Practitioner) identifier FHIR attribute

Description: Whether this practitioner's record is in active use

FHIR Version: r4

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"active": true

Learn more about the (Practitioner) active FHIR attribute

Description: The name(s) associated with the practitioner

FHIR Version: r4

Attribute Type : HumanName

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"name": [
  {
    "family": "Careful",
    "given": [
      "Adam"
    ],
    "prefix": [
      "Dr"
    ]
  }
]

Learn more about the (Practitioner) name FHIR attribute

Description: A contact detail for the practitioner (that apply to all roles)

FHIR Version: r4

Attribute Type : ContactPoint

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"telecom":

Learn more about the (Practitioner) telecom FHIR attribute

Description: Address(es) of the practitioner that are not role specific (typically home address)

FHIR Version: r4

Attribute Type : Address

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"address": [
  {
    "use": "home",
    "line": [
      "534 Erewhon St"
    ],
    "city": "PleasantVille",
    "state": "Vic",
    "postalCode": "3999"
  }
]

Learn more about the (Practitioner) address FHIR attribute

Description: male | female | other | unknown

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"gender":

Learn more about the (Practitioner) gender FHIR attribute

Description: The date on which the practitioner was born

FHIR Version: r4

Attribute Type : date

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"birthDate":

Learn more about the (Practitioner) birthDate FHIR attribute

Description: Image of the person

FHIR Version: r4

Attribute Type : Attachment

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"photo":

Learn more about the (Practitioner) photo FHIR attribute

Description: Certification, licenses, or training pertaining to the provision of care

FHIR Version: r4

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"qualification": [
  {
    "identifier": [
      {
        "system": "http://example.org/UniversityIdentifier",
        "value": "12345"
      }
    ],
    "code": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v2-0360/2.7",
          "code": "BS",
          "display": "Bachelor of Science"
        }
      ],
      "text": "Bachelor of Science"
    },
    "period": {
      "start": "1995"
    },
    "issuer": {
      "display": "Example University"
    }
  }
]

Learn more about the (Practitioner) qualification FHIR attribute

Description: A language the practitioner can use in patient communication

FHIR Version: r4

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"communication":

Learn more about the (Practitioner) communication FHIR attribute

Practitioner Example

{
  "resourceType": "Practitioner",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <p>Dr Adam Careful is a Referring Practitioner for Acme Hospital from 1-Jan 2012 to 31-Mar\n        2012</p>\n    </div>"
  },
  "identifier": [
    {
      "system": "http://www.acme.org/practitioners",
      "value": "23"
    }
  ],
  "active": true,
  "name": [
    {
      "family": "Careful",
      "given": [
        "Adam"
      ],
      "prefix": [
        "Dr"
      ]
    }
  ],
  "address": [
    {
      "use": "home",
      "line": [
        "534 Erewhon St"
      ],
      "city": "PleasantVille",
      "state": "Vic",
      "postalCode": "3999"
    }
  ],
  "qualification": [
    {
      "identifier": [
        {
          "system": "http://example.org/UniversityIdentifier",
          "value": "12345"
        }
      ],
      "code": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v2-0360/2.7",
            "code": "BS",
            "display": "Bachelor of Science"
          }
        ],
        "text": "Bachelor of Science"
      },
      "period": {
        "start": "1995"
      },
      "issuer": {
        "display": "Example University"
      }
    }
  ]
}

Practitioner Structure

{
  "resourceType" : "Practitioner",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // An identifier for the person as this agent
  "active" : <boolean>, // Whether this practitioner's record is in active use
  "name" : [{ HumanName }], // The name(s) associated with the practitioner
  "telecom" : [{ ContactPoint }], // A contact detail for the practitioner (that apply to all roles)
  "address" : [{ Address }], // Address(es) of the practitioner that are not role specific (typically home address)
  "gender" : "<code>", // male | female | other | unknown
  "birthDate" : "<date>", // The date  on which the practitioner was born
  "photo" : [{ Attachment }], // Image of the person
  "qualification" : [{ // Certification, licenses, or training pertaining to the provision of care
    "identifier" : [{ Identifier }], // An identifier for this qualification for the practitioner
    "code" : { CodeableConcept }, // R!  Coded representation of the qualification
    "period" : { Period }, // Period during which the qualification is valid
    "issuer" : { Reference(Organization) } // Organization that regulates and issues the qualification
  }],
  "communication" : [{ CodeableConcept }] // A language the practitioner can use in patient communication
}

Practitioner Search Parameters

The following search parameters can be used to query Practitioner resources. Just submit them like so:

https://api.1up.health/fhir/r4/Practitioner?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`active`	`text`	`active`
`address`	`text`	`address`
`address-city`	`text`	`address.city`
`address-country`	`text`	`address.country`
`address-postalcode`	`text`	`address.postalCode`
`address-state`	`text`	`address.state`
`address-use`	`text`	`address.use`
`communication`	`text`	`communication`
`email`	`text`	`telecom.where`
`family`	`text`	`name.family`
`gender`	`text`	`gender`
`given`	`text`	`name.given`
`identifier`	`text`	`identifier`
`name`	`text`	`name`
`phone`	`text`	`telecom.where`
`phonetic`	`text`	`name`
`telecom`	`text`	`telecom`