AU Core Implementation Guide
1.1.0-ci-build - CI Build Australia flag

AU Core Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.1.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-core/ and changes regularly. See the Directory of published versions

Resource Profile: AU Core PractitionerRole

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole Version: 1.1.0-ci-build
Standards status: Trial-use Maturity Level: 2 Computable Name: AUCorePractitionerRole

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for a PractitionerRole resource to record, search, and fetch a practitioner role for a practitioner associated with a patient. It is based on the AU Base Practitioner Role profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the PractitionerRole resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

See Comparison with other national and international IGs for a comparison between AU Core profiles and profiles in other implementation guides.

Usage scenarios

The following are supported usage scenarios for this profile:

  • Record or update information about a practitioner in a role referenced by another resource
  • Read information about a practitioner in a role referenced by another resource

Profile specific implementation guidance

  • Even though AU Core Profiles allow both PractitionerRole and Practitioner to be referenced, because PractitionerRole supplies a provider’s location, contact information, and reference to the Practitioner, it SHOULD be referenced instead of the Practitioner resource.
  • If a system only supports Practitioner, the system SHALL provide implementation specific guidance how to access a provider’s location and contact information using only the Practitioner resource.
  • Requesters can request responders return the Practitioner resource using _include, see the Notes section below.
  • See guidance on the construction of an identifier on the relevant Identifier profile page and the section on Business Identifiers in AU Base.

Usage:

Changes since version 1.0.0:

  • The resource metadata has changed (description)

    • Formal Views of Profile Content

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

    This structure is derived from AUBasePractitionerRole

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. PractitionerRole 0..* AUBasePractitionerRole A person with formal responsibility in a role providing one or more services
    ... Slices for identifier SO 0..* Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber Business Identifiers that are specific to a role/location
    Slice: Unordered, Open by pattern:type
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... identifier:medicareProvider SO 0..1 AUMedicareProviderNumber Business Identifiers that are specific to a role/location
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... practitioner SOC 1..1 Reference(AU Core Practitioner) Practitioner that is able to provide the defined services for the organization
    au-core-prarol-01: At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... organization SO 0..1 Reference(AU Core Organization) Organization where the roles are available
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... specialty SO 0..* CodeableConcept Specific specialty of the practitioner
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... telecom SO 0..* ContactPoint Contact details that are specific to the role/location/service
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester

    doco Documentation for this format

    Constraints

    IdGradePath(s)DetailsRequirements
    au-core-prarol-01errorPractitionerRole.practitionerAt least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present
    : (reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

     

    Other representations of profile: CSV, Excel, Schematron

    Notes:

    Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU Core CapabilityStatements for a complete list of supported RESTful interactions for this IG.

    FHIR search operations are described here and the syntax used to describe AU Core interactions is defined here.

    Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.

    Parameter(s) Conformance Type(s) Requirements (when used alone or in combination)
    identifier SHALL token The requester SHALL provide both the system and code values. The responder SHALL support both.

    The requester SHOULD support search using a Medicare Provider Number identifier as defined in the profile. The responder SHOULD support search using a Medicare Provider Number identifier as defined in the profile.
    practitioner SHALL reference The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder SHALL support both.

    The requester SHALL provide at least a code value and SHOULD provide both the system and code values.

    The requester SHOULD support chained search practitioner.identifier using a HPI-I identifier as defined in the AU Core Practitioner profile. The responder SHOULD support chained search practitioner.identifier using a HPI-I identifier as defined in the AU Core Practitioner profile.
    _id SHOULD token
    specialty SHOULD token The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both.
    role SHOULD token The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both.
    organization MAY reference The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder SHALL support both.

    Mandatory Search Parameters

    The following search parameters SHALL be supported:

    1. SHALL support searching using the identifier search parameter:
      • SHOULD support these _include parameters: PractitionerRole:practitioner

      GET [base]/PractitionerRole?identifier=[system|][code]

      Example:

      1. GET [base]/PractitionerRole?identifier=http://ns.electronichealth.net.au/id/medicare-provider-number|2426621B&_include=PractitionerRole:practitioner
      2. GET [base]/PractitionerRole?identifier=http://ns.electronichealth.net.au/id/medicare-provider-number|2426621B

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

    2. SHALL support searching using the practitioner search parameters:
      • SHOULD support chained searching of practitioner canonical identifier practitioner.identifier (e.g. practitioner.identifier=[system|][code])
      • SHOULD support these _include parameters: PractitionerRole:practitioner

      GET [base]/PractitionerRole?practitioner={Type/}[id] or optionally GET [base]/PractitionerRole?practitioner.identifier=[system|][code]

      Example:

      1. GET [base]/PractitionerRole?practitioner=Practitioner/sandyson-sandy
      2. GET [base]/PractitionerRole?practitioner=Practitioner/sandyson-sandy&_include=PractitionerRole:practitioner
      3. GET [base]/PractitionerRole?practitioner.identifier=http://ns.electronichealth.net.au/id/hi/hpii/1.0|8003619900015717

      Implementation Notes: Fetches a bundle of all PractitionerRole resources matching the specified practitioner (how to search by reference and how to search by token)

    Optional Search Parameters

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

    1. SHOULD support searching using the _id search parameter:
      • SHOULD support these _include parameters: PractitionerRole:practitioner

      GET [base]/PractitionerRole?_id=[id]

      Example:

      1. GET [base]/PractitionerRole/_id=5678
      2. GET [base]/PractitionerRole?_id=5678&_include=PractitionerRole:practitioner

      Implementation Notes: Fetches a bundle with the requested PractitionerRole, instead of just the resource itself, and allows for the inclusion of additional search parameters such as _include, _revinclude, or _lastUpdated (how to search by id of the resource)

    2. SHOULD support searching using the specialty search parameter:
      • SHOULD support these _include parameters: PractitionerRole:practitioner

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

      Example:

      1. GET [base]/PractitionerRole?specialty=http://snomed.info/sct|408443003
      2. GET [base]/PractitionerRole?specialty=http://snomed.info/sct|408443003&_include=PractitionerRole:practitioner

      Implementation Notes: Fetches a bundle of all PractitionerRole resources for the specified specialty (how to search by token)

    3. SHOULD support searching using the role search parameter:
      • SHOULD support these _include parameters: PractitionerRole:practitioner

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

      Example:

      1. GET [base]/PractitionerRole?role=http://snomed.info/sct|304292004
      2. GET [base]/PractitionerRole?role=http://snomed.info/sct|304292004&_include=PractitionerRole:practitioner

      Implementation Notes: Fetches a bundle of all PractitionerRole resources for the specified role (how to search by token)