Share via

Veterans Affairs Providers (Independent Publisher) (Preview)

  • Reference

The Provider Directory API facilitates the development of applications that can retrieve lists of VA providers, offering details on provider locations, specialties, office hours, and patient acceptance status. It leverages FHIR standards to ensure compliance with CMS requirements for public-facing API endpoints.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Richard Wilson
URL https://www.richardawilson.com
Email [email protected]
Connector Metadata
Publisher Richard Wilson
DaVinci PDEX Plan Net Implementation Guide https://docs.microsoft.com/connectors/veteransaffairsprovi
Website https://developer.va.gov
Privacy policy https://www.va.gov/privacy/
Categories Human Resources

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
VA API Key securestring The VA API Key for this api True
Environment string The VA API environment to use (Production or Sandbox) True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Get location by ID

Retrieves detailed information about a specific location by its ID, including provider locations, specialties, and office hours.
Get organization by Id

Retrieves detailed information about a specific organization by its ID, including name, location, and other relevant details.
Get practitioner by ID

Retrieves detailed information about a specific practitioner by their unique ID, including identifiers, names, and qualifications.
Get practitioner role by ID

Retrieves detailed information about a specific practitioner role by its unique ID, including role assignments, qualifications, and identifiers.
List locations

Retrieves a list of locations based on specified criteria, including provider locations, specialties, and office hours.
List organizations

Retrieves a list of organizations based on specified criteria, including their locations, names, and other identifying information.
List practitioner roles

Retrieves a list of practitioner roles based on specified criteria, including identifiers and names, reflecting their roles and responsibilities.
List practitioners

Retrieves a list of practitioners based on specified criteria, including identifiers, names, and last update dates.

Get location by ID

Operation ID:
GetLocationById

Retrieves detailed information about a specific location by its ID, including provider locations, specialties, and office hours.

Parameters

Name Key Required Type Description
Id
 id True string

The logical ID of the resource. Once assigned, this value never changes.

Returns

Information about physical locations where services are provided and resources are located.

Body
Location

Get organization by Id

Operation ID:
GetOrganizationById

Retrieves detailed information about a specific organization by its ID, including name, location, and other relevant details.

Parameters

Name Key Required Type Description
Id
 id True string

The logical ID of the resource. Once assigned, this value never changes.

Returns

Represents a group of people defined by a common purpose, such as a hospital, department, team, or insurance company.

Body
Organization

Get practitioner by ID

Operation ID:
GetPractitionerById

Retrieves detailed information about a specific practitioner by their unique ID, including identifiers, names, and qualifications.

Parameters

Name Key Required Type Description
Id
 id True string

The logical ID of the resource. Once assigned, this value never changes.

Returns

A person who is directly or indirectly involved in the provision of healthcare.

Body
Practitioner

Get practitioner role by ID

Operation ID:
GetPractitionerRoleById

Retrieves detailed information about a specific practitioner role by its unique ID, including role assignments, qualifications, and identifiers.

Parameters

Name Key Required Type Description
Id
 id True string

The logical ID of the resource, which remains unchanged once assigned.

Returns

Defines the role of a practitioner within a healthcare organization or practice.

Body
PractitionerRole

List locations

Operation ID:
GetLocation

Retrieves a list of locations based on specified criteria, including provider locations, specialties, and office hours.

Parameters

Name Key Required Type Description
Id
 _id string

The logical ID of the resource. Once assigned, this value never changes.
Identifier
 identifier string

The logical identifier of the resource. Once assigned, this value never changes.
Address
 address string

Specifies the physical location of the record using postal conventions.
Address City
 address-city string

Specifies the city where the location resides.
Address State
 address-state string

Specifies the state where the location resides.
Address Postalcode
 address-postalcode string

Specifies the postal code for the region where the location resides.
Name
 name string

Indicates the name of the location as referenced by humans.
Last Updated
 _lastUpdated string

The date when the location record was last updated.
Page
 page integer

The page number of the search result.
Count
 _count integer

The number of resources returned in a single page, up to a maximum of 100.

Returns

A collection of 'Location' resources returned as a result of a search/query operation.

Body
LocationBundle

List organizations

Operation ID:
ListOrganizations

Retrieves a list of organizations based on specified criteria, including their locations, names, and other identifying information.

Parameters

Name Key Required Type Description
Id
 _id string

The logical ID of the resource. Once assigned, this value never changes.
Identifier
 identifier string

The logical identifier of the resource. Once assigned, this value never changes.
Address
 address string

Specifies the physical location of the organization using postal conventions.
City
 address-city string

Specifies the city where the organization resides.
State
 address-state string

Specifies the state where the organization resides.
Postal Code
 address-postalcode string

Specifies the postal code for the region where the organization resides.
Name
 name string

Indicates the name of the organization as it is referenced by humans.
Last Updated
 _lastUpdated string

The date when the organization record was last updated.
Page
 page integer

The page number of the search result.
Count
 _count integer

The number of resources returned in a single page, up to a maximum of 100.

Returns

Body
OrganizationBundle

List practitioner roles

Operation ID:
ListPractitionerRoles

Retrieves a list of practitioner roles based on specified criteria, including identifiers and names, reflecting their roles and responsibilities.

Parameters

Name Key Required Type Description
Id
 _id string

The logical ID of the resource. Once assigned, this value never changes.
Practitioner Identifier
 practitioner.identifier string

A unique identifier for a practitioner within a given system.
Practitioner Name
 practitioner.name string

The given or family name of the practitioner.
Last Updated
 _lastUpdated string

The date when the practitioner role record was last updated.
Page
 page integer

The page number being requested.
Count
 _count integer

The number of resources returned in a single page, up to a maximum of 100.

Returns

A bundle of practitioner role resources, typically used to provide a complete set of search results or a subset of resources in a paginated list.

Body
PractitionerRoleBundle

List practitioners

Operation ID:
ListPractitioners

Retrieves a list of practitioners based on specified criteria, including identifiers, names, and last update dates.

Parameters

Name Key Required Type Description
Id
 _id string

The logical ID of the resource. Once assigned, this value never changes.
Identifier
 identifier string

A unique identifier for a practitioner within a given system.
Family Name
 family string

The family name of the practitioner.
Given Name
 given string

The given name of the practitioner.
Name
 name string

The given or family name of the practitioner.
Last Updated
 _lastUpdated string

The date when the practitioner record was last updated.
Page
 page integer

The page number of the search result.
Count
 _count integer

The number of resources returned in a single page, up to a maximum of 100.

Returns

A bundle of resources containing information about one or more practitioners.

Body
PractitionerBundle

Definitions

Address

Defines a physical location by its address components.

Name Path Type Description
City
 city string

The city name of the address.
Country
 country string

The country name of the address.
District
 district string

The district or subregion of the address that helps in further location.
Extension
 extension array of object

Extension contains extra information about the address.
items
 extension object
Id
 id string

A unique identifier for the address.
Line
 line array of string

The actual address line that describes the physical location.
period
 period Period

A period of time described by start and end date/time boundaries.
Postal Code
 postalCode string

The postal code of the address.
State
 state string

The state or province of the address.
Text
 text string

A textual representation of the address.
Type
 type string

The type of address (postal, physical, or both).
Use
 use string

The use of the address (home, work, temp, old, billing).

Attachment

A complex type containing content in digital form.

Name Path Type Description
Content Type
 contentType string

The mime type of the content.
Creation
 creation string

The date and time when the content was created.
Data
 data string

The actual data of the content, represented as a base64 string.
Extension
 extension array of object

An extension for additional structured data.
items
 extension object
Hash
 hash string

A hash of the data (e.g., SHA-1, SHA-256, or MD5) for integrity verification.
Id
 id string

A unique identifier for the attachment.
Language
 language string

The language of the content, represented as a BCP-47 language tag.
Size
 size integer

The size of the data in bytes.
Title
 title string

A label or title for the attachment.
Url
 url string

A URL where the data can be accessed.

A link related to a bundle resource.

Name Path Type Description
Extension
 extension array of object

An extension for additional structured data.
items
 extension object
Id
 id string

A unique identifier for the link.
Modifier Extension
 modifierExtension array of object

An extension that modifies other elements.
items
 modifierExtension object
Relation
 relation string

The type of relation to the linked resource (e.g., next, previous, etc.).
Url
 url string

The URL that points to the target of the link.

CodeableConcept

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Name Path Type Description
Coding
 coding array of Coding

A list of codings for the concept.
Extension
 extension array of object

An extension for additional structured data related to the CodeableConcept.
items
 extension object
Id
 id string

A unique identifier for the CodeableConcept instance.
Text
 text string

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Coding

A reference to a code defined in a coding system.

Name Path Type Description
Code
 code string

The symbol in syntax defined by the system.
Display
 display string

A representation of the meaning of the code in human language.
Extension
 extension array of object

Additional data provided through extensions.
items
 extension object
Id
 id string

A unique identifier for this coding instance.
System
 system string

The identification of the code system that defines the meaning of the symbol in the code.
User Selected
 userSelected boolean

Indicates whether this coding was selected directly by the user.
Version
 version string

The version of the code system which was used to choose this code.

ContactPoint

Details of a technology-mediated contact point (phone, fax, email, etc.).

Name Path Type Description
Extension
 extension array of object

Additional data provided through extensions.
items
 extension object
Id
 id string

A unique identifier for this contact point instance.
period
 period Period

A period of time described by start and end date/time boundaries.
Rank
 rank integer

Specifies a preference order for this contact point.
System
 system string

The system of technology-mediated communication.
Use
 use string

Identifies the purpose for this contact point.
Value
 value string

The actual contact point details, such as phone number or email address.

HoursOfOperation

Specifies the hours during which operations are conducted.

Name Path Type Description
All Day
 allDay boolean

Indicates whether the service is available all day.
Closing Time
 closingTime string

The time when operations end for the day.
Days of Week
 daysOfWeek array of string

The days of the week when operations are conducted.
Extension
 extension array of object

Additional content defined by extensions.
items
 extension object
Id
 id string

A unique identifier for these hours of operation.
Modifier Extension
 modifierExtension array of object

Extensions that modify the hours of operation.
items
 modifierExtension object
Opening Time
 openingTime string

The time when operations begin for the day.

HumanName

A human's name with the ability to identify parts and usage.

Name Path Type Description
Extension
 extension array of object

Additional content defined by extensions.
items
 extension object
Family
 family string

The family name (often called 'Surname').
Given
 given array of string

Given names (not including the family name).
Id
 id string

A unique identifier for the human name.
period
 period Period

A period of time described by start and end date/time boundaries.
Prefix
 prefix array of string

Honorifics or titles preceding the name.
Suffix
 suffix array of string

Qualifiers or titles following the name.
Text
 text string

Text representation of the full name.
Use
 use string

Identifies the purpose for this name.

Identifier

A unique identifier assigned to an entity.

Name Path Type Description
Assigner
 assigner object

The organization that issued the identifier.
Extension
 extension array of object

Additional data for the identifier.
items
 extension object
Id
 id string

A unique identifier for the Identifier instance.
period
 period Period

A period of time described by start and end date/time boundaries.
System
 system string

The system that is used to assign the identifier.
type
 type CodeableConcept

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Use
 use string

The intended use of the identifier.
Value
 value string

The value of the identifier.

Location

Information about physical locations where services are provided and resources are located.

Name Path Type Description
address
 address Address

Defines a physical location by its address components.
Alias
 alias array of string

A list of alternative names that the location is known as, or was known as in the past.
Availability Exceptions
 availabilityExceptions string

A description of when the location is not available.
Contained
 contained array of Resource

Contained, inline Resources.
Description
 description string

Description of the Location, which helps in finding or referencing the place.
Endpoint
 endpoint array of object

Technical endpoints providing access to services operated for the location.
items
 endpoint object
Extension
 extension array of object

Additional content defined by extensions.
items
 extension object
hoursOfOperation
 hoursOfOperation HoursOfOperation

Specifies the hours during which operations are conducted.
Id
 id string

Unique identifier for the Location resource.
Identifier
 identifier array of Identifier

Unique code or number identifying the location to its users.
Implicit Rules
 implicitRules string

A set of rules under which this content was created.
Language
 language string

The language of the resource content.
Managing Organization
 managingOrganization object

The organization responsible for the provisioning and upkeep of the location.
meta
 meta Meta

Metadata about a resource, including version, profile, and security.
Mode
 mode string

Indicates whether the location is still in use.
Modifier Extension
 modifierExtension array of object

Extensions that cannot be ignored.
items
 modifierExtension object
Name
 name string

Name of the location as used by humans.
operationalStatus
 operationalStatus Coding

A reference to a code defined in a coding system.
Part Of
 partOf object

Another Location of which this Location is physically a part of.
physicalType
 physicalType CodeableConcept

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
position
 position Position

The geographical position of a point.
Resource Type
 resourceType string

The type of the resource (Location).
Status
 status string

The status of the location (e.g., active, suspended, inactive).
Telecom
 telecom array of ContactPoint

Contact details of the location.
text
 text Narrative

A human-readable summary of the resource conveying the essential clinical and business information for the resource.
Type
 type array of CodeableConcept

Type of function performed at the location.

LocationBundle

A collection of 'Location' resources returned as a result of a search/query operation.

Name Path Type Description
Entry
 entry array of LocationEntry

A list of entries, each encapsulating a 'Location' resource.
Id
 id string

Unique identifier for the bundle.
identifier
 identifier Identifier

A unique identifier assigned to an entity.
Implicit Rules
 implicitRules string

A reference to the rules under which the bundle was generated.
Language
 language string

The language of the bundle.
Link
 link array of BundleLink

A series of links that provide the context of this bundle.
meta
 meta Meta

Metadata about a resource, including version, profile, and security.
Resource Type
 resourceType string

The type of the resource (Bundle).
signature
 signature Signature

A digital signature along with supporting context and metadata.
Timestamp
 timestamp string

The date/time at which the bundle was composed.
Total
 total integer

The total number of resources in the bundle.
Type
 type string

The type of the bundle (e.g., document, searchset, collection).

LocationEntry

An entry in a 'LocationBundle' containing a 'Location' resource and related information.

Name Path Type Description
Extension
 extension array of object

Additional content defined by extensions.
items
 extension object
Full Url
 fullUrl string

The absolute URL that is the target of the entry.
Id
 id string

Unique identifier for the entry within the bundle.
Link
 link array of BundleLink

A series of links related to the entry.
Modifier Extension
 modifierExtension array of object

Extensions that modify the entry.
items
 modifierExtension object
request
 request Request

A request resource within a bundle.
resource
 resource Location

Information about physical locations where services are provided and resources are located.
response
 response Response

A response resource within a bundle.
search
 search Search

A resource that represents a search operation or search capability.

Meta

Metadata about a resource, including version, profile, and security.

Name Path Type Description
Extension
 extension array of object

Additional content defined by extensions.
items
 extension object
Id
 id string

Unique identifier for the Meta instance.
Last Updated
 lastUpdated string

The last time the resource was updated.
Profile
 profile array of string

Profiles that define the resource's structure and use.
Security
 security array of Coding

Security tags for the resource.
Source
 source string

The location where the resource was generated.
Tag
 tag array of Coding

Tags for the resource.
Version Id
 versionId string

The version of the resource.

Narrative

A human-readable summary of the resource conveying the essential clinical and business information for the resource.

Name Path Type Description
Div
 div string

The XHTML content of the narrative.
Extension
 extension array of object

Additional content defined by extensions.
items
 extension object
Id
 id string

Unique identifier for the Narrative instance.
Status
 status string

The status of the narrative content generation.

Organization

Represents a group of people defined by a common purpose, such as a hospital, department, team, or insurance company.

Name Path Type Description
Active
 active boolean

Indicates whether the organization is active or inactive.
address
 address array of Address
Alias
 alias array of string

A list of alternative names that the organization is known by, or was known by in the past.
contact
 contact array of OrganizationContact
contained
 contained array of Resource
Endpoint
 endpoint array of object

Technical endpoints providing access to electronic services operated for the organization.
items
 endpoint object
Extension
 extension array of object

Extensions for additional information.
items
 extension object
Id
 id string

Unique identifier for the Organization instance.
identifier
 identifier array of Identifier
Implicit Rules
 implicitRules string

A reference to the set of rules under which this resource was created.
Language
 language string

The language of the resource content.
meta
 meta Meta

Metadata about a resource, including version, profile, and security.
Modifier Extension
 modifierExtension array of object

Extensions that modify the resource.
items
 modifierExtension object
Name
 name string

The name of the organization.
Part Of
 partOf object

The organization of which this organization forms a part.
Resource Type
 resourceType string

Type of resource (Organization).
telecom
 telecom array of ContactPoint
text
 text Narrative

A human-readable summary of the resource conveying the essential clinical and business information for the resource.
type
 type array of CodeableConcept

OrganizationBundle

Name Path Type Description
entry
 entry array of OrganizationEntry
Identifier
 id string

The unique identifier for this bundle.
identifier
 identifier Identifier

A unique identifier assigned to an entity.
Implicit Rules
 implicitRules string

A reference to the set of rules applied to the bundle.
Language
 language string

The language of the content in the bundle.
link
 link array of BundleLink
meta
 meta Meta

Metadata about a resource, including version, profile, and security.
Resource Type
 resourceType string

Defines the type of resource, in this case, a bundle.
signature
 signature Signature

A digital signature along with supporting context and metadata.
Timestamp
 timestamp string

The date and time when the bundle was compiled.
Total
 total integer

The total number of entries in the bundle.
Type
 type string

The type of bundle, such as document, message, transaction.

OrganizationContact

A contact detail for the organization.

Name Path Type Description
address
 address Address

Defines a physical location by its address components.
Extension
 extension array of object

Additional content defined by implementations.
items
 extension object
Identifier
 id string

Unique identifier for the organization contact.
Modifier Extension
 modifierExtension array of object

Extensions that cannot be ignored even if unrecognized.
items
 modifierExtension object
name
 name HumanName

A human's name with the ability to identify parts and usage.
purpose
 purpose CodeableConcept

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
telecom
 telecom array of ContactPoint

OrganizationEntry

Represents an entry in an organization bundle.

Name Path Type Description
Extension
 extension array of object

Extension for additional information.
items
 extension object
Full URL
 fullUrl string

The full URL for the resource.
ID
 id string

The unique identifier for the entry.
Link
 link array of BundleLink

A series of links that provide context to this entry.
Modifier Extension
 modifierExtension array of object

Extensions that modify the resource.
items
 modifierExtension object
request
 request Request

A request resource within a bundle.
resource
 resource Organization

Represents a group of people defined by a common purpose, such as a hospital, department, team, or insurance company.
response
 response Response

A response resource within a bundle.
search
 search Search

A resource that represents a search operation or search capability.

Period

A period of time described by start and end date/time boundaries.

Name Path Type Description
End
 end string

The end date/time of the period.
Extension
 extension array of object

Additional information or metadata about the period.
items
 extension object
Id
 id string

Unique identifier for the period.
Start
 start string

The start date/time of the period.

Position

The geographical position of a point.

Name Path Type Description
Altitude
 altitude number

The altitude in meters above the reference ellipsoid.
Extension
 extension array of object

Additional information or metadata about the position.
items
 extension object
Id
 id string

Unique identifier for the position.
Latitude
 latitude number

The latitude in decimal degrees (WGS 84).
Longitude
 longitude number

The longitude in decimal degrees (WGS 84).
Modifier Extension
 modifierExtension array of object

Additional information or metadata about the position.
items
 modifierExtension object

Practitioner

A person who is directly or indirectly involved in the provision of healthcare.

Name Path Type Description
Active
 active boolean

Indicates if the practitioner is currently active in healthcare provision.
Address
 address array of Address

The address(es) where the practitioner can be contacted or visited.
Birth Date
 birthDate string

The date of birth of the practitioner.
Communication
 communication array of CodeableConcept

A language the practitioner is able to use in patient communication.
Contained
 contained array of Resource

Resources contained in this resource.
Extensions
 extensions array of object

Additional information or metadata about the practitioner.
items
 extensions object
Gender
 gender string

The gender identity of the practitioner.
Id
 id string

Unique identifier for the practitioner.
Identifier
 identifier array of Identifier

A list of the practitioner's identifiers.
Implicit Rules
 implicitRules string

A reference to a set of rules that were followed when the resource was constructed.
Language
 language string

Language the practitioner is able to use in patient communication.
meta
 meta Meta

Metadata about a resource, including version, profile, and security.
Modifier Extensions
 modifierExtensions array of object

Additional information or metadata about the practitioner.
items
 modifierExtensions object
Name
 name array of HumanName

The name(s) associated with the practitioner.
Photo
 photo array of Attachment

A photo of the practitioner.
Qualification
 qualification array of PractitionerQualification

Qualifications obtained by training and certification.
Resource Type
 resourceType string

Type of resource (Practitioner).
Telecom
 telecom array of ContactPoint

A contact detail for the practitioner.
text
 text Narrative

A human-readable summary of the resource conveying the essential clinical and business information for the resource.

PractitionerAvailableTime

The times that the practitioner is available for appointments.

Name Path Type Description
All Day
 allDay boolean

Indicates whether the practitioner is available all day.
Available End Time
 availableEndTime string

The end time that the practitioner is available for appointments.
Available Start Time
 availableStartTime string

The start time that the practitioner is available for appointments.
Days of Week
 daysOfWeek array of string

The days of the week that the practitioner is available for appointments.
Extension
 extension array of object

Additional information or metadata about the practitioner's availability.
items
 extension object
Id
 id string

Unique identifier for the practitioner availability.
Modifier Extension
 modifierExtension array of object

Additional information or metadata about the practitioner's availability.
items
 modifierExtension object

PractitionerBundle

A bundle of resources containing information about one or more practitioners.

Name Path Type Description
Entry
 entry array of PractitionerEntry

An entry in the bundle - will have a resource, or information about a search, etc.
Id
 id string

Unique identifier for the bundle.
identifier
 identifier Identifier

A unique identifier assigned to an entity.
Implicit Rules
 implicitRules string

A reference to a set of rules that were followed when the resource was constructed.
Language
 language string

Language of the resource content.
Link
 link array of BundleLink

Links related to this Bundle.
meta
 meta Meta

Metadata about a resource, including version, profile, and security.
Resource Type
 resourceType string

Type of resource (Bundle).
signature
 signature Signature

A digital signature along with supporting context and metadata.
Timestamp
 timestamp string

When the bundle was assembled.
Total
 total integer

If search, the total number of matches.
Type
 type string

The type of the resource.

PractitionerEntry

An entry in the bundle containing information about a practitioner.

Name Path Type Description
Extension
 extension array of object

Additional information or metadata about the practitioner entry.
items
 extension object
Full URL
 fullUrl string

The URL of the entry.
ID
 id string

Unique identifier for the practitioner entry.
Link
 link array of BundleLink

Links related to this practitioner entry.
Modifier Extension
 modifierExtension array of object

Additional information or metadata about the practitioner entry.
items
 modifierExtension object
request
 request Request

A request resource within a bundle.
resource
 resource Practitioner

A person who is directly or indirectly involved in the provision of healthcare.
response
 response Response

A response resource within a bundle.
search
 search Search

A resource that represents a search operation or search capability.

PractitionerNotAvailable

The times when the practitioner is not available for appointments.

Name Path Type Description
Description
 description string

A description of why the practitioner is not available.
during
 during Period

A period of time described by start and end date/time boundaries.
Extension
 extension array of object

Additional information or metadata about the practitioner's unavailability.
items
 extension object
ID
 id string

Unique identifier for the practitioner's unavailability.
Modifier Extension
 modifierExtension array of object

Additional information or metadata about the practitioner's unavailability.
items
 modifierExtension object

PractitionerQualification

The qualifications or certifications held by the practitioner.

Name Path Type Description
code
 code CodeableConcept

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Extension
 extension array of object

Additional information or metadata about the practitioner's qualification.
items
 extension object
ID
 id string

Unique identifier for the practitioner qualification.
Identifier
 identifier array of Identifier

Identifiers associated with the practitioner qualification.
Issuer
 issuer object

The entity that issued the qualification.
Modifier Extension
 modifierExtension array of object

Additional information or metadata about the practitioner's qualification.
items
 modifierExtension object
period
 period Period

A period of time described by start and end date/time boundaries.

PractitionerRole

Defines the role of a practitioner within a healthcare organization or practice.

Name Path Type Description
Active
 active boolean

Indicates whether this practitioner's role is currently active.
Availability Exceptions
 availabilityExceptions string

Additional information about the availability of this practitioner's role, if applicable.
Available Time
 availableTime array of PractitionerAvailableTime

The times during which this practitioner is available for appointments or other services.
Code
 code array of CodeableConcept

The code(s) that identify the type of healthcare provider role being fulfilled.
Contained
 contained array of Resource

Related resources that are defined inline within the resource.
Endpoint
 endpoint array of object

The technical endpoints providing access to services operated for the practitioner.
items
 endpoint object
Extension
 extension array of object

Additional content defined by implementations.
items
 extension object
Healthcare Service
 healthcareService array of object

The healthcare services that this practitioner provides for the organization or practice.
items
 healthcareService object
ID
 id string

The logical identifier for this practitioner role.
Identifier
 identifier array of Identifier

The unique identifier(s) for this practitioner role within the context of a particular system.
Implicit Rules
 implicitRules string

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Language
 language string

The base language in which the resource is written.
Location
 location array of object

The location(s) where this practitioner provides services.
items
 location object
meta
 meta Meta

Metadata about a resource, including version, profile, and security.
Modifier Extension
 modifierExtension array of object

Additional content defined by implementations that modifies the content of the resource in some way.
items
 modifierExtension object
Not Available
 notAvailable array of PractitionerNotAvailable

The times during which this practitioner is not available for appointments or other services.
Organization
 organization object

The organization or healthcare service where this practitioner role is defined.
period
 period Period

A period of time described by start and end date/time boundaries.
Practitioner
 practitioner object

The practitioner who is responsible for the services provided by this role.
Resource Type
 resourceType string

A type of resource that is identifiable along with other resources.
Specialty
 specialty array of CodeableConcept

Specific specialty services provided by the practitioner within the context of this role.
Telecom
 telecom array of ContactPoint

Contact details for the practitioner role.
text
 text Narrative

A human-readable summary of the resource conveying the essential clinical and business information for the resource.

PractitionerRoleBundle

A bundle of practitioner role resources, typically used to provide a complete set of search results or a subset of resources in a paginated list.

Name Path Type Description
Entry
 entry array of PractitionerRoleEntry

An entry in the bundle - will have a resource, or information about a resource.
ID
 id string

The logical identifier for this bundle.
identifier
 identifier Identifier

A unique identifier assigned to an entity.
Implicit Rules
 implicitRules string

A reference to a set of rules that were followed when the bundle was constructed, and which must be understood when processing the content.
Language
 language string

The base language in which the resource is written.
Link
 link array of BundleLink

A series of links that provide context to this bundle.
meta
 meta Meta

Metadata about a resource, including version, profile, and security.
Resource Type
 resourceType string

A type of resource that is identifiable along with other resources.
signature
 signature Signature

A digital signature along with supporting context and metadata.
Timestamp
 timestamp string

The time that the bundle was assembled.
Total
 total integer

The total number of entries in the bundle.
Type
 type string

The type of bundle - indicates whether it is a document, message, transaction, etc.

PractitionerRoleEntry

An entry in a bundle of type 'PractitionerRole' containing information about a practitioner's role.

Name Path Type Description
Extension
 extension array of object

Additional information or metadata about the entry.
items
 extension object
Full URL
 fullUrl string

The full URL of the resource in the entry.
ID
 id string

Unique identifier for the entry.
Link
 link array of BundleLink

Links related to this entry.
Modifier Extension
 modifierExtension array of object

Additional information or metadata about the entry.
items
 modifierExtension object
request
 request Request

A request resource within a bundle.
resource
 resource PractitionerRole

Defines the role of a practitioner within a healthcare organization or practice.
response
 response Response

A response resource within a bundle.
search
 search Search

A resource that represents a search operation or search capability.

Request

A request resource within a bundle.

Name Path Type Description
object

A request resource within a bundle.

Resource

A FHIR resource that represents a single coherent concept or occurrence of a thing.

Name Path Type Description
object

A FHIR resource that represents a single coherent concept or occurrence of a thing.

Response

A response resource within a bundle.

Name Path Type Description
object

A response resource within a bundle.

A resource that represents a search operation or search capability.

Name Path Type Description
object

A resource that represents a search operation or search capability.

Signature

A digital signature along with supporting context and metadata.

Name Path Type Description
Data
 data string

The base64 encoded signature content.
Extension
 extension array of object

Additional information defined by implementations.
items
 extension object
Id
 id string

The unique identifier for this signature.
On Behalf Of
 onBehalfOf object

The party represented by this signature.
Signature Format
 sigFormat string

The technical format of the signature content.
Target Format
 targetFormat string

The technical format of the signed content.
Type
 type array of Coding

The coding representing the purpose of the signature.
When
 when string

When the signature was created.
Who
 who object

Who this signature is made for.