AU Core Implementation Guide
0.1.0-draft - Draft Australia flag

This page is part of the AU Core Implementation Guide 0.1.0 Draft. It is based on AU Base 4.1.0. For a full list of available versions, see the Directory of published versions

Resource Profile: AU Core PractitionerRole

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole Version: 0.1.0-draft
Standards status: Draft Maturity Level: 0 Computable Name: AUCorePractitionerRole

Copyright/Legal: HL7 Australia© 2018+; 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.

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

None.

Usage:

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..*AUBasePractitionerRoleA person with formal responsibility in a role providing one or more services
... Slices for identifier S1..*Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumberBusiness Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
.... identifier:hpii S0..1AUHPIIHealthcare Provider Identifier – Individual (HPI-I)
.... identifier:caei S0..1AUCareAgencyEmployeeIdentifierCare Agency Employee (CAE) Identifier
.... identifier:medicareProvider S0..1AUMedicareProviderNumberMedicare Provider Number
... active 0..1booleanWhether this practitioner role record is in active use
Fixed Value: true
... practitioner SC1..1Reference(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
... code S0..*CodeableConceptRoles which this practitioner may perform
... specialty S0..*CodeableConceptSpecific specialty of the practitioner
... location S0..*Reference(AU Core Location)The location(s) at which this practitioner provides care
... healthcareService S0..1Reference(AU Core HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom S0..*ContactPointContact details that are specific to the role/location/service

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
au-core-prarol-01errorPractitionerRole.practitionerAt least a reference, identifier or display shall be present
: reference.exists() or identifier.exists() or display.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*AUBasePractitionerRoleA person with formal responsibility in a role providing one or more services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S1..*Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumberBusiness Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
.... identifier:hpii SC0..1AUHPIIHealthcare Provider Identifier – Individual (HPI-I)
.... identifier:caei SC0..1AUCareAgencyEmployeeIdentifierCare Agency Employee (CAE) Identifier
.... identifier:medicareProvider S0..1AUMedicareProviderNumberMedicare Provider Number
... practitioner SΣC1..1Reference(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
... organization SΣ0..1Reference(AU Core Organization)Organization where the roles are available
... code SΣ0..*CodeableConceptRoles which this practitioner may perform
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred)
... specialty SΣ0..*CodeableConceptSpecific specialty of the practitioner
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred)
... location SΣ0..*Reference(AU Core Location)The location(s) at which this practitioner provides care
... healthcareService S0..1Reference(AU Core HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SΣ0..*ContactPointContact details that are specific to the role/location/service

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PractitionerRole.codepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
PractitionerRole.specialtypreferredhttps://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-prarol-01errorPractitionerRole.practitionerAt least a reference, identifier or display shall be present
: reference.exists() or identifier.exists() or display.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*AUBasePractitionerRoleA person with formal responsibility in a role providing one or more services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S1..*Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumberBusiness Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
.... identifier:hpii SC0..1AUHPIIHealthcare Provider Identifier – Individual (HPI-I)
.... identifier:caei SC0..1AUCareAgencyEmployeeIdentifierCare Agency Employee (CAE) Identifier
.... identifier:medicareProvider S0..1AUMedicareProviderNumberMedicare Provider Number
... active Σ0..1booleanWhether this practitioner role record is in active use
Fixed Value: true
... period Σ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣC1..1Reference(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
... organization SΣ0..1Reference(AU Core Organization)Organization where the roles are available
... code SΣ0..*CodeableConceptRoles which this practitioner may perform
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred)
... specialty SΣ0..*CodeableConceptSpecific specialty of the practitioner
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred)
... location SΣ0..*Reference(AU Core Location)The location(s) at which this practitioner provides care
... healthcareService S0..1Reference(AU Core HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SΣ0..*ContactPointContact details that are specific to the role/location/service
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... timeZone 0..1CodeableConceptAU time zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
..... value 0..1timePrimitive value for time
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... timeZone 0..1CodeableConceptAU time zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
..... value 0..1timePrimitive value for time
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PractitionerRole.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
PractitionerRole.codepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
PractitionerRole.specialtypreferredhttps://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePath(s)DetailsRequirements
au-core-prarol-01errorPractitionerRole.practitionerAt least a reference, identifier or display shall be present
: reference.exists() or identifier.exists() or display.exists()

Differential View

This structure is derived from AUBasePractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*AUBasePractitionerRoleA person with formal responsibility in a role providing one or more services
... Slices for identifier S1..*Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumberBusiness Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
.... identifier:hpii S0..1AUHPIIHealthcare Provider Identifier – Individual (HPI-I)
.... identifier:caei S0..1AUCareAgencyEmployeeIdentifierCare Agency Employee (CAE) Identifier
.... identifier:medicareProvider S0..1AUMedicareProviderNumberMedicare Provider Number
... active 0..1booleanWhether this practitioner role record is in active use
Fixed Value: true
... practitioner SC1..1Reference(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
... code S0..*CodeableConceptRoles which this practitioner may perform
... specialty S0..*CodeableConceptSpecific specialty of the practitioner
... location S0..*Reference(AU Core Location)The location(s) at which this practitioner provides care
... healthcareService S0..1Reference(AU Core HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom S0..*ContactPointContact details that are specific to the role/location/service

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
au-core-prarol-01errorPractitionerRole.practitionerAt least a reference, identifier or display shall be present
: reference.exists() or identifier.exists() or display.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*AUBasePractitionerRoleA person with formal responsibility in a role providing one or more services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S1..*Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumberBusiness Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
.... identifier:hpii SC0..1AUHPIIHealthcare Provider Identifier – Individual (HPI-I)
.... identifier:caei SC0..1AUCareAgencyEmployeeIdentifierCare Agency Employee (CAE) Identifier
.... identifier:medicareProvider S0..1AUMedicareProviderNumberMedicare Provider Number
... practitioner SΣC1..1Reference(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
... organization SΣ0..1Reference(AU Core Organization)Organization where the roles are available
... code SΣ0..*CodeableConceptRoles which this practitioner may perform
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred)
... specialty SΣ0..*CodeableConceptSpecific specialty of the practitioner
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred)
... location SΣ0..*Reference(AU Core Location)The location(s) at which this practitioner provides care
... healthcareService S0..1Reference(AU Core HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SΣ0..*ContactPointContact details that are specific to the role/location/service

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PractitionerRole.codepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
PractitionerRole.specialtypreferredhttps://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-prarol-01errorPractitionerRole.practitionerAt least a reference, identifier or display shall be present
: reference.exists() or identifier.exists() or display.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*AUBasePractitionerRoleA person with formal responsibility in a role providing one or more services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S1..*Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumberBusiness Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
.... identifier:hpii SC0..1AUHPIIHealthcare Provider Identifier – Individual (HPI-I)
.... identifier:caei SC0..1AUCareAgencyEmployeeIdentifierCare Agency Employee (CAE) Identifier
.... identifier:medicareProvider S0..1AUMedicareProviderNumberMedicare Provider Number
... active Σ0..1booleanWhether this practitioner role record is in active use
Fixed Value: true
... period Σ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣC1..1Reference(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
... organization SΣ0..1Reference(AU Core Organization)Organization where the roles are available
... code SΣ0..*CodeableConceptRoles which this practitioner may perform
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred)
... specialty SΣ0..*CodeableConceptSpecific specialty of the practitioner
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred)
... location SΣ0..*Reference(AU Core Location)The location(s) at which this practitioner provides care
... healthcareService S0..1Reference(AU Core HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SΣ0..*ContactPointContact details that are specific to the role/location/service
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... timeZone 0..1CodeableConceptAU time zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
..... value 0..1timePrimitive value for time
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... timeZone 0..1CodeableConceptAU time zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
..... value 0..1timePrimitive value for time
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PractitionerRole.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
PractitionerRole.codepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
PractitionerRole.specialtypreferredhttps://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePath(s)DetailsRequirements
au-core-prarol-01errorPractitionerRole.practitionerAt least a reference, identifier or display shall be present
: reference.exists() or identifier.exists() or display.exists()

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.

Name Type Conformance Description Path
TBD TBD TBD TBD TBD

Mandatory Search Parameters

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

Optional Search Parameters

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