Australian Digital Health Agency FHIR
1.2.0-ci-build - draft Australia flag

Australian Digital Health Agency FHIR, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/mcv/ and changes regularly. See the Directory of published versions

Resource Profile: ADHA Core PractitionerRole

Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-practitionerrole-core-1 Version: 1.0.0
Active as of 2024-09-16 Computable Name: ADHAPractitionerRoleCore

Copyright/Legal: Copyright © 2022 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

The purpose of this profile is to define a core representation of a practitioner in a role, on behalf of an organisation, for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.

This profile identifies the additional constraints, extensions, and value sets that build on and extend PractitionerRole that are supported.

A PractitionerRole resource is used within the context of a referencing resource.

This profile is designed to set a core PractitionerRole standard for:

  • Recording or updating a practitioner role referenced by another resource
  • Reading practitioner roles referenced by another resource

Profile specific guidance

None.

Usage:

Formal Views of Profile Content

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

This structure is derived from AUCorePractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C 0..* AUCorePractitionerRole A person with formal responsibility in a role providing one or more services
inv-dh-prarol-01: If present, an organization shall at least have a reference, an identifier or a display
inv-dh-prarol-02: If present, a location shall at least have a reference, an identifier or a display
inv-dh-prarol-03: If present, a healthcare service shall at least have a reference, an identifier or a display
... Slices for identifier S 1..* Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber Business Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
.... identifier:hpii S 0..1 AUHPII Business Identifiers that are specific to a role/location
.... identifier:caei S 0..1 AUCareAgencyEmployeeIdentifier Business Identifiers that are specific to a role/location
... active 0..1 boolean Whether this practitioner role record is in active use
Fixed Value: true
... organization SC 0..1 Reference(ADHA Core Organization) Organization where the roles are available
... healthcareService SC 0..1 Reference(ADHA Core HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-prarol-01errorPractitionerRoleIf present, an organization shall at least have a reference, an identifier or a display
: organization.exists() implies organization.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-prarol-02errorPractitionerRoleIf present, a location shall at least have a reference, an identifier or a display
: location.exists() implies location.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-prarol-03errorPractitionerRoleIf present, a healthcare service shall at least have a reference, an identifier or a display
: healthcareService.exists() implies healthcareService.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C 0..* AUCorePractitionerRole A person with formal responsibility in a role providing one or more services
inv-dh-prarol-01: If present, an organization shall at least have a reference, an identifier or a display
inv-dh-prarol-02: If present, a location shall at least have a reference, an identifier or a display
inv-dh-prarol-03: If present, a healthcare service shall at least have a reference, an identifier or a display
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SO 1..* Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber Business Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
.... identifier:medicareProvider SO 0..1 AUMedicareProviderNumber Medicare Provider Number
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
.... identifier:hpii SO 0..1 AUHPII Business Identifiers that are specific to a role/location
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
.... identifier:caei SO 0..1 AUCareAgencyEmployeeIdentifier Business Identifiers that are specific to a role/location
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... practitioner SOΣC 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 http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... organization SOΣC 0..1 Reference(ADHA Core Organization) Organization where the roles are available
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... code SOΣ 0..* CodeableConcept Roles which this practitioner may perform
Binding: Practitioner Role . (preferred)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... specialty SOΣ 0..* CodeableConcept Specific specialty of the practitioner
Binding: Clinical Specialty . (preferred)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... location SΣC 0..* Reference(ADHA Core Location) The location(s) at which this practitioner provides care
... healthcareService SC 0..1 Reference(ADHA Core HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SOΣ 0..* ContactPoint Contact details that are specific to the role/location/service
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.codepreferredPractitionerRole .
https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
PractitionerRole.specialtypreferredClinicalSpecialty .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-prarol-01errorPractitionerRoleIf present, an organization shall at least have a reference, an identifier or a display
: organization.exists() implies organization.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-prarol-02errorPractitionerRoleIf present, a location shall at least have a reference, an identifier or a display
: location.exists() implies location.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-prarol-03errorPractitionerRoleIf present, a healthcare service shall at least have a reference, an identifier or a display
: healthcareService.exists() implies healthcareService.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C 0..* AUCorePractitionerRole A person with formal responsibility in a role providing one or more services
inv-dh-prarol-01: If present, an organization shall at least have a reference, an identifier or a display
inv-dh-prarol-02: If present, a location shall at least have a reference, an identifier or a display
inv-dh-prarol-03: If present, a healthcare service shall at least have a reference, an identifier or a display
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SO 1..* Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber Business Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
.... identifier:medicareProvider SO 0..1 AUMedicareProviderNumber Medicare Provider Number
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
.... identifier:hpii SO 0..1 AUHPII Business Identifiers that are specific to a role/location
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
.... identifier:caei SO 0..1 AUCareAgencyEmployeeIdentifier Business Identifiers that are specific to a role/location
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... active Σ 0..1 boolean Whether this practitioner role record is in active use
Fixed Value: true
... period Σ 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
... practitioner SOΣC 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 http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... organization SOΣC 0..1 Reference(ADHA Core Organization) Organization where the roles are available
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... code SOΣ 0..* CodeableConcept Roles which this practitioner may perform
Binding: Practitioner Role . (preferred)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... specialty SOΣ 0..* CodeableConcept Specific specialty of the practitioner
Binding: Clinical Specialty . (preferred)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... location SΣC 0..* Reference(ADHA Core Location) The location(s) at which this practitioner provides care
... healthcareService SC 0..1 Reference(ADHA Core HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SOΣ 0..* ContactPoint Contact details that are specific to the role/location/service
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... availableTime 0..* BackboneElement Times the Service Site is available
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1 boolean Always available? e.g. 24 hour service
.... availableStartTime 0..1 time Opening time of day (ignored if allDay = true)
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... timeZone 0..1 CodeableConcept AU time zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
..... value 0..1 time Primitive value for time
.... availableEndTime 0..1 time Closing time of day (ignored if allDay = true)
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... timeZone 0..1 CodeableConcept AU time zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
..... value 0..1 time Primitive value for time
... notAvailable 0..* BackboneElement Not available during this time due to provided reason
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description 1..1 string Reason presented to the user explaining why time not available
.... during 0..1 Period Service not available from this date
... availabilityExceptions 0..1 string Description 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

PathConformanceValueSetURI
PractitionerRole.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
PractitionerRole.codepreferredPractitionerRole .
https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
PractitionerRole.specialtypreferredClinicalSpecialty .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-prarol-01errorPractitionerRoleIf present, an organization shall at least have a reference, an identifier or a display
: organization.exists() implies organization.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-prarol-02errorPractitionerRoleIf present, a location shall at least have a reference, an identifier or a display
: location.exists() implies location.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-prarol-03errorPractitionerRoleIf present, a healthcare service shall at least have a reference, an identifier or a display
: healthcareService.exists() implies healthcareService.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())

Differential View

This structure is derived from AUCorePractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C 0..* AUCorePractitionerRole A person with formal responsibility in a role providing one or more services
inv-dh-prarol-01: If present, an organization shall at least have a reference, an identifier or a display
inv-dh-prarol-02: If present, a location shall at least have a reference, an identifier or a display
inv-dh-prarol-03: If present, a healthcare service shall at least have a reference, an identifier or a display
... Slices for identifier S 1..* Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber Business Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
.... identifier:hpii S 0..1 AUHPII Business Identifiers that are specific to a role/location
.... identifier:caei S 0..1 AUCareAgencyEmployeeIdentifier Business Identifiers that are specific to a role/location
... active 0..1 boolean Whether this practitioner role record is in active use
Fixed Value: true
... organization SC 0..1 Reference(ADHA Core Organization) Organization where the roles are available
... healthcareService SC 0..1 Reference(ADHA Core HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-prarol-01errorPractitionerRoleIf present, an organization shall at least have a reference, an identifier or a display
: organization.exists() implies organization.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-prarol-02errorPractitionerRoleIf present, a location shall at least have a reference, an identifier or a display
: location.exists() implies location.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-prarol-03errorPractitionerRoleIf present, a healthcare service shall at least have a reference, an identifier or a display
: healthcareService.exists() implies healthcareService.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C 0..* AUCorePractitionerRole A person with formal responsibility in a role providing one or more services
inv-dh-prarol-01: If present, an organization shall at least have a reference, an identifier or a display
inv-dh-prarol-02: If present, a location shall at least have a reference, an identifier or a display
inv-dh-prarol-03: If present, a healthcare service shall at least have a reference, an identifier or a display
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SO 1..* Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber Business Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
.... identifier:medicareProvider SO 0..1 AUMedicareProviderNumber Medicare Provider Number
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
.... identifier:hpii SO 0..1 AUHPII Business Identifiers that are specific to a role/location
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
.... identifier:caei SO 0..1 AUCareAgencyEmployeeIdentifier Business Identifiers that are specific to a role/location
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... practitioner SOΣC 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 http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... organization SOΣC 0..1 Reference(ADHA Core Organization) Organization where the roles are available
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... code SOΣ 0..* CodeableConcept Roles which this practitioner may perform
Binding: Practitioner Role . (preferred)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... specialty SOΣ 0..* CodeableConcept Specific specialty of the practitioner
Binding: Clinical Specialty . (preferred)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... location SΣC 0..* Reference(ADHA Core Location) The location(s) at which this practitioner provides care
... healthcareService SC 0..1 Reference(ADHA Core HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SOΣ 0..* ContactPoint Contact details that are specific to the role/location/service
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.codepreferredPractitionerRole .
https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
PractitionerRole.specialtypreferredClinicalSpecialty .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-prarol-01errorPractitionerRoleIf present, an organization shall at least have a reference, an identifier or a display
: organization.exists() implies organization.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-prarol-02errorPractitionerRoleIf present, a location shall at least have a reference, an identifier or a display
: location.exists() implies location.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-prarol-03errorPractitionerRoleIf present, a healthcare service shall at least have a reference, an identifier or a display
: healthcareService.exists() implies healthcareService.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C 0..* AUCorePractitionerRole A person with formal responsibility in a role providing one or more services
inv-dh-prarol-01: If present, an organization shall at least have a reference, an identifier or a display
inv-dh-prarol-02: If present, a location shall at least have a reference, an identifier or a display
inv-dh-prarol-03: If present, a healthcare service shall at least have a reference, an identifier or a display
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SO 1..* Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber Business Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
.... identifier:medicareProvider SO 0..1 AUMedicareProviderNumber Medicare Provider Number
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
.... identifier:hpii SO 0..1 AUHPII Business Identifiers that are specific to a role/location
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
.... identifier:caei SO 0..1 AUCareAgencyEmployeeIdentifier Business Identifiers that are specific to a role/location
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... active Σ 0..1 boolean Whether this practitioner role record is in active use
Fixed Value: true
... period Σ 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
... practitioner SOΣC 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 http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... organization SOΣC 0..1 Reference(ADHA Core Organization) Organization where the roles are available
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... code SOΣ 0..* CodeableConcept Roles which this practitioner may perform
Binding: Practitioner Role . (preferred)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... specialty SOΣ 0..* CodeableConcept Specific specialty of the practitioner
Binding: Clinical Specialty . (preferred)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... location SΣC 0..* Reference(ADHA Core Location) The location(s) at which this practitioner provides care
... healthcareService SC 0..1 Reference(ADHA Core HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SOΣ 0..* ContactPoint Contact details that are specific to the role/location/service
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
... availableTime 0..* BackboneElement Times the Service Site is available
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1 boolean Always available? e.g. 24 hour service
.... availableStartTime 0..1 time Opening time of day (ignored if allDay = true)
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... timeZone 0..1 CodeableConcept AU time zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
..... value 0..1 time Primitive value for time
.... availableEndTime 0..1 time Closing time of day (ignored if allDay = true)
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... timeZone 0..1 CodeableConcept AU time zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
..... value 0..1 time Primitive value for time
... notAvailable 0..* BackboneElement Not available during this time due to provided reason
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description 1..1 string Reason presented to the user explaining why time not available
.... during 0..1 Period Service not available from this date
... availabilityExceptions 0..1 string Description 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

PathConformanceValueSetURI
PractitionerRole.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
PractitionerRole.codepreferredPractitionerRole .
https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
PractitionerRole.specialtypreferredClinicalSpecialty .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-prarol-01errorPractitionerRoleIf present, an organization shall at least have a reference, an identifier or a display
: organization.exists() implies organization.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-prarol-02errorPractitionerRoleIf present, a location shall at least have a reference, an identifier or a display
: location.exists() implies location.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-prarol-03errorPractitionerRoleIf present, a healthcare service shall at least have a reference, an identifier or a display
: healthcareService.exists() implies healthcareService.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())

 

Other representations of profile: CSV, Excel, Schematron