Validated Healthcare Directory, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/VhDir/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-practitionerrole | Version: 1.0.0 | |||
Active as of 2017-10-03 | Computable Name: VhdirPractitionerRole | |||
Copyright/Legal: Used by permission of HL7 International all rights reserved Creative Commons License |
Defines the basic constraints and extensions on the PractitionerRole resource for use in a Validated Healthcare Directory
This profile sets minimum expectations for searching for and fetching information associated with a practitioner role. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the PractitionerRole resource when using this profile.
Background & Scope
PractitionerRole describes the role a practitioner plays at an organization, including the services they provide, the location(s) where they work, and their availability, electronic endpoints, and other relevant information.
This profile modifies the base PractitionerRole resource in the following manner:
Constrains the cardinality of practitionerRole.active
(1..1) and practitionerRole.code
(1..*)
All references SHALL conform to the appropriate Validated Healthcare Directory Implementation Guide profile
Adds extensions:
TBD
Examples:
The following are example uses for the vhdir-practitionerrole profile:
Mandatory Data Elements
The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.
Each practitionerRole must have:
practitionerRole.active
practitionerRole.code
Profile specific implementation guidance:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Other representations of profile: CSV, Excel, Schematron
GET [base]/PractitionerRole?active=[code]
Support: SHALL support search by the active
parameter: http://hl7.org/fhir/SearchParameter/PractitionerRole-active
GET [base]/PractitionerRole?endpoint=[id]
Support: SHOULD support search by the endpoint
parameter
Endpoint
endpoint.identifier
, endpoint.connection-type
, endpoint.organization
GET [base]/PractitionerRole?identifier=[code]
Support: SHALL support search by the identifier
parameter
text
, ofType
GET [base]/PractitionerRole?identifier-assigner=[id]
Support: MAY support search by the identifier-assigner
parameter
Organization
below
identifier-assigner.identifier
, identifier-assigner.name
GET [base]/PractitionerRole?location=[id]
Support: SHALL support search by the location
parameter
Location
above
, below
location.identifier
, location.type
, location.address
, location.organization
GET [base]/PractitionerRole?network=[id]
Support: SHOULD support search by the network
parameter
Organization
network.identifier
, network.name
, network.partof
GET [base]/PractitionerRole?new-patient=[code]
Support: SHOULD support search by the new-patient
parameter
GET [base]/PractitionerRole?new-patient-network=[id]
Support: SHOULD support search by the new-patient-network
parameter
Organization
new-patient-network.identifier
, new-patient-network.name
, new-patient-network.partof
GET [base]/PractitionerRole?organization=[id]
Support: SHALL support search by the organization
parameter
Organization
above
, below
organization.identifier
, organization.name
, organization.address
, organization.partof
, organization-type
GET [base]/PractitionerRole?practitioner=[id]
Support: SHALL support search by the practitioner
parameter
Practitioner
practitioner.identifier
, practitioner.name
GET [base]/PractitionerRole?qualification-code=[code]
Support: SHOULD support search by the qualification-code
parameter
text
GET [base]/PractitionerRole?qualification-issuer=[id]
Support: MAY support search by the qualification-issuer
parameter
Organization
below
qualification-issuer.identifier
, qualification-issuer.name
GET [base]/PractitionerRole?qualification-status=[code]
Support: SHOULD support search by the qualification-status
parameter
GET [base]/PractitionerRole?qualification-wherevalid-code=[code]
Support: SHOULD support search by the qualification-wherevalid-code
parameter
text
GET [base]/PractitionerRole?qualification-wherevalid-location=[id]
Support: SHOULD support search by the qualification-wherevalid-location
parameter
Location
above
, below
qualification-wherevalid-location.identifier
, qualification-wherevalid-location.address
, qualification-wherevalid-location.organization
GET [base]/PractitionerRole?role=[code]
Support: SHALL support search by the role
parameter
text
GET [base]/PractitionerRole?service=[id]
Support: SHOULD support search by the service
parameter
HealthcareService
service.identifier
, service.service-category
, service.organization
, service.location
GET [base]/PractitionerRole?specialty=[code]
Support: SHOULD support search by the specialty
parameter
text
GET [base]/PractitionerRole?via-intermediary=[id]
Support: MAY support search by the via-intermediary
parameter
PractitionerRole
, Organization
, OrganizationAffiliation
, Location