Australian Digital Health Agency FHIR Implementation Guide 1.1.0

This page is part of the Australian Digital Health Agency FHIR Implementation Guide 1.1.0. It is based on FHIR® version 4.0.1. See the Directory of published versions for a list of available previous versions.

StructureDefinition: ADHA Authoring PractitionerRole [Active]

The purpose of this profile is to define a core representation of a practitioner acting as an author or observer in a healthcare role, on behalf of an organisation, that is for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia. In the context of an exchange of health information a practitioner role is part of the context established for a set of healthcare-related information.

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 PractitionerRole standard for:

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

Profile specific guidance

None.

Boundaries and relationships

This profile is referenced by ADHA Core Condition, ADHA Core DocumentReference, ADHA Core Flag, ADHA Record of Immunisation from Australian Immunisation Register, ADHA Core Immunization, ADHA Core MedicationRequest, ADHA Core Observation, and ADHA Core Procedure.

Formal Views of Profile Content

The official URL for this profile is: 

http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-practitionerrole-author-1

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

This profile builds on ADHAPractitionerRoleCore.

This profile was published on 2023-08-07 09:41:43+1000 as a active by Australian Digital Health Agency.

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*ADHAPractitionerRoleCoreA practitioner acting as an author or observer in a healthcare role, on behalf of an organisation
... practitioner 1..1Reference(ADHA Core Practitioner)Practitioner that is able to provide the defined services for the organization
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... organization 1..1Reference(ADHA Core Organization)Organization where the roles are available
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... telecom 1..*ContactPointContact details that are specific to the role/location/service

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C0..*ADHAPractitionerRoleCoreA practitioner acting as an author or observer in a healthcare role, on behalf of an organisation
... 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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... 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(ADHA Core Practitioner)Practitioner that is able to provide the defined services for the organization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... organization SΣC1..1Reference(ADHA Core Organization)Organization where the roles are available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... 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ΣC0..*Reference(ADHA Core Location)The location(s) at which this practitioner provides care
... healthcareService SC0..1Reference(ADHA Core HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SΣ1..*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

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*ADHAPractitionerRoleCoreA practitioner acting as an author or observer in a healthcare role, on behalf of an organisation
... practitioner 1..1Reference(ADHA Core Practitioner)Practitioner that is able to provide the defined services for the organization
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... organization 1..1Reference(ADHA Core Organization)Organization where the roles are available
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... telecom 1..*ContactPointContact details that are specific to the role/location/service

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C0..*ADHAPractitionerRoleCoreA practitioner acting as an author or observer in a healthcare role, on behalf of an organisation
... 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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... 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(ADHA Core Practitioner)Practitioner that is able to provide the defined services for the organization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... organization SΣC1..1Reference(ADHA Core Organization)Organization where the roles are available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... 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ΣC0..*Reference(ADHA Core Location)The location(s) at which this practitioner provides care
... healthcareService SC0..1Reference(ADHA Core HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SΣ1..*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

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

Terminology Bindings

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

Search Parameters

None defined.