IE (Ireland) Core Implementation Guide
1.0.0-ballot - Ballot Ireland flag

Publication Build: This will be filled in by the publication tooling

Resource Profile: IE Core PractitionerRole Profile

Official URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-practitionerrole Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: IECorePractitionerRoleProfile
Other Identifiers: OID:1.3.6.1.4.1.54392.5.2690.42.48

Copyright/Legal: iEHR.ai, all rights reserved Creative Commons License

The IE Core PractionerRole Profile inherits from the FHIR PractionerRole resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the PractitionerRole Resource to record, search, and fetch the practitioner role information. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

Mandatory and Must Support Data Elements

The following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.

Each PractitionerRole Must Support:

  1. An associated organization
  2. An associated practitioner
  3. A role
  4. A specialty
  5. An associated location
  6. Contact information
  7. A communication endpoint

Profile Specific Implementation Guidance:

  • At least one of the following elements must be present:
    • PractitionerRole.practitioner
    • PractitionerRole.organization
    • PractitionerRole.healthcareService
    • PractitionerRole.location
  • Due to implementer feedback, some IE Core Profiles reference the PractitionerRole resource instead of the IE Core PractitionerRole Profile. However, the IE Core PractitionerRole Profile SHOULD be used as the default profile if referenced by another IE Core profile. See this guidance on Referencing IE Core Profiles.
  • A Direct address can be represented in the telecom element using the IE Core Direct email Extension or in a referenced Endpoint as a "direct-project" endpoint connection type.
  • When selecting role codes, implementers SHOULD choose the code that reflects the specific duties performed within that role rather than the specialty unless the individual's professional specialization characterizes the role.
  • Clients can request servers return the Practitioner and Endpoint resources using _include. See the Quick Start section below for further guidance.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C 0..* PractitionerRole Roles/organizations the practitioner is associated with
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
pd-1: SHALL have contact information or a reference to an Endpoint
ie-core-13: SHALL have a practitioner, an organization, a healthcare service, or a location.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... practitioner SΣC 0..1 Reference(IE Core Practitioner Profile) Practitioner that is able to provide the defined services for the organization
ele-1: All FHIR elements must have a @value or children
... organization SΣC 0..1 Reference(IE Core Organization Profile) Organization where the roles are available
ele-1: All FHIR elements must have a @value or children
... code SΣ 0..* CodeableConcept Roles which this practitioner may perform
Binding: IE Core Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.


ele-1: All FHIR elements must have a @value or children
... specialty SΣ 0..* CodeableConcept Specific specialty of the practitioner
Binding: IE Core Healthcare Provider Taxonomy (extensible)
ele-1: All FHIR elements must have a @value or children
... location SΣC 0..* Reference(IE Core Location Profile) The location(s) at which this practitioner provides care
ele-1: All FHIR elements must have a @value or children
... healthcareService C 0..* Reference(HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
ele-1: All FHIR elements must have a @value or children
... telecom SΣC 0..* ContactPoint Contact details that are specific to the role/location/service
ele-1: All FHIR elements must have a @value or children
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
.... value SΣ 1..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
... endpoint SC 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the practitioner with this role
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.codeextensibleIECoreCareTeamMemberFunction
http://iehr.ai/fhir/ie/core/ValueSet/ie-core-care-team-member-function
from this IG
PractitionerRole.specialtyextensibleIECoreHealthcareProviderTaxonomy (a valid code from IE Core Healthcare Provider Taxonomy Codes)
http://iehr.ai/fhir/ie/core/ValueSet/ie-core-healthcare-provider-taxonomy
from this IG
PractitionerRole.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
PractitionerRole.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ie-core-13errorPractitionerRoleSHALL have a practitioner, an organization, a healthcare service, or a location.
: practitioner.exists() or organization.exists() or healthcareService.exists() or location.exists()
pd-1errorPractitionerRoleSHALL have contact information or a reference to an Endpoint
: telecom.exists() or endpoint.exists()

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Quick Start

Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the IE Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only IE Core Profiles (Profile Only Support) are not required to support these interactions. See the IE Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

  • See the Scopes Format section for a description of the SMART scopes syntax.
  • See the Search Syntax section for a description of the IE Core search syntax.
  • See the General Requirements section for additional rules and expectations when a server requires status parameters.
  • See the General Guidance section for additional guidance on searching for multiple patients.

IE Core Scopes

Servers providing access to practitioner role data SHALL support these IE Core SMART Scopes:

Mandatory Search Parameters:

The following search parameters and search parameter combinations SHALL be supported:

  1. SHALL support searching practitioner role by specialty using the specialty search parameter:

    • including optional support for these _include parameters: PractitionerRole:endpoint,PractitionerRole:practitioner

    GET [base]/PractitionerRole?specialty={system|}[code]

    Example:

    1. GET [base]/PractitionerRole?specialty=http://nucc.org/provider-taxonomy|208D0000X

    Implementation Notes: Fetches a bundle containing PractitionerRole resources matching the specialty (how to search by token)

  2. SHALL support searching practitioner role by practitioner name and identifier using chained parameters using the practitioner search parameter:

    • including support for these chained parameters: practitioner.identifier,practitioner.name
    • including optional support for these _include parameters: PractitionerRole:endpoint,PractitionerRole:practitioner

    GET [base]/PractitionerRole?practitioner={Type/}[id]

    Example:

    1. GET [base]/PractitionerRole?practitioner.identifier=http://iehr.ai/fhir/sid/ie/crn|97860456&_include=PractitionerRole:practitioner&_include=PractitionerRole?endpoint
    2. GET [base]/PractitionerRole?practitioner.name=Henry&_include=PractitionerRole:practitioner&_include=PractitionerRole?endpoint

    Implementation Notes: Fetches a bundle containing PractitionerRole resources matching the chained parameter practitioner.name or practitioner.identifier.SHOULD support the _include for PractionerRole.practitioner and PractitionerRole.endpoint. (how to search by reference)