xCaliber healthCare Data Mesh

Practitioner

Overview

The Practitioner API allows managing provider directories by creating, retrieving, and updating individual provider profiles. Healthcare developers can use it to build applications for provider search, identity management, and integration with electronic health record systems.

Use Cases

  • Provider Directories - Build and maintain directories of doctors, nurses, therapists, and other practitioners.
  • Credentialing and Privileging - Manage practitioner credentials, licenses, certifications, affiliations.
  • Clinical Workflow Integration - Incorporate practitioner data into EHR functions like ordering, documentation.
  • Scheduling - Enable scheduling applications to access details on practitioner availability, roles, locations.
  • Referral Management - Create practitioner profiles to facilitate electronic referrals and care coordination.
  • Identity Management - Uniquely identify practitioners across applications and enable single sign-on.
  • Analytics - Analyze practitioner data to gain insights into network demographics, productivity, costs.
  • Compliance Reporting - Generate reports on practitioners to fulfill accreditation and regulatory requirements.
  • Patient Assignment - Link patients to their responsible primary care providers or care teams.
  • Telehealth - Manage practitioner profiles and availability for virtual care and telemedicine.

EHR Data Model

EHRSupported?Mapped Source Object
AthenaProviders
ElationPhysician, Contacts, Thread Member, Users
EpicN/A

Object Definition

{
  "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"
      }
    }
  ],
  "meta": {
    "tag": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
        "code": "HTEST",
        "display": "test health data"
      }
    ]
  }
}

Data Fields

Data FieldTypeDescription
resourceTypePractitionerThis is a Practitioner resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedBackboneElementThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionExtensionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierIdentifierAn identifier that applies to this person in this role.
activebooleanWhether this practitioner's record is in active use.
nameHumanNameThe name(s) associated with the practitioner.
telecomContactPointA contact detail for the practitioner, e.g. a telephone number or an email address.
addressAddressAddress(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.
gendercodeAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
birthDatedateThe date of birth for the practitioner.
photoAttachmentImage of the person.
qualificationBackboneElementThe official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.
qualification.idstringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
qualification.extensionExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
qualification.modifierExtensionExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
qualification.identifierIdentifierAn identifier that applies to this person's qualification in this role.
qualification.codeCodeableConceptCoded representation of the qualification.
qualification.periodPeriodPeriod during which the qualification is valid.
qualification.issuerReferenceOrganization that regulates and issues the qualification.
communicationCodeableConceptA language the practitioner can use in patient communication.

Extensions

NameURL
PRACTICEhttp://xcaliber-fhir/structureDefinition/practice
ACCEPTINGNEWPATIENTSYNhttp://xcaliber-fhir/structureDefinition/accepting-new-patients-yn
ANSINAMECODEhttp://xcaliber-fhir/structureDefinition/ansi-name-code
ANSISPECIALTYCODEhttp://xcaliber-fhir/structureDefinition/ansi-specialty-code
BILLABLEhttp://xcaliber-fhir/structureDefinition/billable
CREATEENCOUNTERONCHECKINYNhttp://xcaliber-fhir/structureDefinition/create-encounter-on-checkin-yn
CREATEENCOUNTERPROVIDERIDLISThttp://xcaliber-fhir/structureDefinition/create-encounter-provider-id-list
DIRECTADDRESShttp://xcaliber-fhir/structureDefinition/direct-address
ENTITYTYPEhttp://xcaliber-fhir/structureDefinition/entity-type
FEDERALIDNUMBERhttp://xcaliber-fhir/structureDefinition/federal-id-number
HIDEINPORTALYNhttp://xcaliber-fhir/structureDefinition/hide-in-portal-yn
HOMEDEPARTMENThttp://xcaliber-fhir/structureDefinition/home-department
OTHERPROVIDERIDLISThttp://xcaliber-fhir/structureDefinition/other-provider-id-list
PERSONALPRONOUNShttp://xcaliber-fhir/structureDefinition/personal-pronouns
PROVIDERGROUPLISThttp://xcaliber-fhir/structureDefinition/provider-group-list
PROVIDERTYPEhttp://xcaliber-fhir/structureDefinition/provider-type
PROVIDERTYPEIDhttp://xcaliber-fhir/structureDefinition/provider-type-id
PROVIDERUSERNAMEhttp://xcaliber-fhir/structureDefinition/provider-user-name
SCHEDULERESOURCETYPEhttp://xcaliber-fhir/structureDefinition/schedule-resource-type
SCHEDULINGNAMEhttp://xcaliber-fhir/structureDefinition/scheduling-name
SUPERVISINGPROVIDERIDhttp://xcaliber-fhir/structureDefinition/supervising-provider-id
SUPERVISINGPROVIDERUSERNAMEhttp://xcaliber-fhir/structureDefinition/supervising-provider-username
USUALDEPARTMENTIDhttp://xcaliber-fhir/structureDefinition/usual-department-id
SIGNATUREONFILEFLAGhttp://xcaliber-fhir/structureDefinition/signature-on-file-flag
PRACTITIONERSPECIALITYhttp://xcaliber-fhir/structureDefinition/practitioner-speciality

Operations & APIs

Practitioner-GET

Practitioner-POST

Practitioner ID-GET

Practitioner ID-PUT

Practitioner ID-DELETE

Practitioner Export-POST