Australian Digital Health Agency FHIR Implementation Guide, 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/ci-fhir-r4/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• XML
• JSON
• TTL

Resource Profile: ADHA Authoring Care Agency Employee

The purpose of this profile is to define a representation of a care agency employee (practitioner) acting as an author or observer, 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.

Usage:

• Refer to this Resource Profile: ADHA Personal Health Notes Composition, ADHA Personal Health Summary Composition, ADHA Personal Health Summary Composition and ADHA Personal Observations Composition

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from ADHAPractitionerRoleAuthoring

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	ADHAPractitionerRoleAuthoring	A care agency employee acting as an author or observer, on behalf of an organisation
Slices for identifier				Content/Rules for all slices
identifier:caei	S	1..1	AUCareAgencyEmployeeIdentifier	Care Agency Employee (CAE) Identifier
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole	C	0..*	ADHAPractitionerRoleAuthoring	A care agency employee acting as an author or observer, on behalf of an organisation 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	S	1..*	Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber	Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
identifier:hpii	SC	0..1	AUHPII	Healthcare Provider Identifier – Individual (HPI-I) inv-hpii-0: HPI-I shall be 16 digits inv-hpii-1: HPI-I prefix shall be 800361 inv-hpii-2: HPI-I shall pass the Luhn algorithm check
identifier:caei	SC	1..1	AUCareAgencyEmployeeIdentifier	Care Agency Employee (CAE) Identifier inv-caei-0: CAE identifier shall be 16 digits inv-caei-1: CAE identifier prefix shall be 900360 inv-caei-2: CAE identifier shall pass the Luhn algorithm check
identifier:medicareProvider	S	0..1	AUMedicareProviderNumber	Medicare Provider Number
practitioner	SΣC	1..1	Reference(ADHA Core Practitioner)	Practitioner that is able to provide the defined services for the organization inv-dh-prarol-04: At least a reference, identifier or display shall be present
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
organization	SΣC	1..1	Reference(ADHA Core Organization)	Organization where the roles are available
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
code	SΣ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: Practitioner Role (preferred)
specialty	SΣ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: Clinical Specialty (preferred)
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	SΣ	1..*	ContactPoint	Contact details that are specific to the role/location/service
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PractitionerRole.code	preferred	PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 from https://tx.ontoserver.csiro.au/fhir
PractitionerRole.specialty	preferred	ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 from https://tx.ontoserver.csiro.au/fhir

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole	C	0..*	ADHAPractitionerRoleAuthoring	A care agency employee acting as an author or observer, on behalf of an organisation 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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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	S	1..*	Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber	Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
identifier:hpii	SC	0..1	AUHPII	Healthcare Provider Identifier – Individual (HPI-I) inv-hpii-0: HPI-I shall be 16 digits inv-hpii-1: HPI-I prefix shall be 800361 inv-hpii-2: HPI-I shall pass the Luhn algorithm check
identifier:caei	SC	1..1	AUCareAgencyEmployeeIdentifier	Care Agency Employee (CAE) Identifier inv-caei-0: CAE identifier shall be 16 digits inv-caei-1: CAE identifier prefix shall be 900360 inv-caei-2: CAE identifier shall pass the Luhn algorithm check
identifier:medicareProvider	S	0..1	AUMedicareProviderNumber	Medicare Provider Number
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	SΣC	1..1	Reference(ADHA Core Practitioner)	Practitioner that is able to provide the defined services for the organization inv-dh-prarol-04: At least a reference, identifier or display shall be present
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
organization	SΣC	1..1	Reference(ADHA Core Organization)	Organization where the roles are available
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
code	SΣ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: Practitioner Role (preferred)
specialty	SΣ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: Clinical Specialty (preferred)
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	SΣ	1..*	ContactPoint	Contact details that are specific to the role/location/service
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PractitionerRole.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
PractitionerRole.practitioner.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
PractitionerRole.organization.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
PractitionerRole.code	preferred	PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 from https://tx.ontoserver.csiro.au/fhir
PractitionerRole.specialty	preferred	ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 from https://tx.ontoserver.csiro.au/fhir
PractitionerRole.availableTime.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

This structure is derived from ADHAPractitionerRoleAuthoring

Summary

Mandatory: 1 element
Must-Support: 1 element

Structures

This structure refers to these other structures:

• AU Care Agency Employee Identifier (http://hl7.org.au/fhir/StructureDefinition/au-careagencyemployeeidentifier)

Differential View

This structure is derived from ADHAPractitionerRoleAuthoring

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	ADHAPractitionerRoleAuthoring	A care agency employee acting as an author or observer, on behalf of an organisation
Slices for identifier				Content/Rules for all slices
identifier:caei	S	1..1	AUCareAgencyEmployeeIdentifier	Care Agency Employee (CAE) Identifier
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole	C	0..*	ADHAPractitionerRoleAuthoring	A care agency employee acting as an author or observer, on behalf of an organisation 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	S	1..*	Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber	Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
identifier:hpii	SC	0..1	AUHPII	Healthcare Provider Identifier – Individual (HPI-I) inv-hpii-0: HPI-I shall be 16 digits inv-hpii-1: HPI-I prefix shall be 800361 inv-hpii-2: HPI-I shall pass the Luhn algorithm check
identifier:caei	SC	1..1	AUCareAgencyEmployeeIdentifier	Care Agency Employee (CAE) Identifier inv-caei-0: CAE identifier shall be 16 digits inv-caei-1: CAE identifier prefix shall be 900360 inv-caei-2: CAE identifier shall pass the Luhn algorithm check
identifier:medicareProvider	S	0..1	AUMedicareProviderNumber	Medicare Provider Number
practitioner	SΣC	1..1	Reference(ADHA Core Practitioner)	Practitioner that is able to provide the defined services for the organization inv-dh-prarol-04: At least a reference, identifier or display shall be present
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
organization	SΣC	1..1	Reference(ADHA Core Organization)	Organization where the roles are available
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
code	SΣ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: Practitioner Role (preferred)
specialty	SΣ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: Clinical Specialty (preferred)
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	SΣ	1..*	ContactPoint	Contact details that are specific to the role/location/service
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PractitionerRole.code	preferred	PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 from https://tx.ontoserver.csiro.au/fhir
PractitionerRole.specialty	preferred	ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 from https://tx.ontoserver.csiro.au/fhir

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole	C	0..*	ADHAPractitionerRoleAuthoring	A care agency employee acting as an author or observer, on behalf of an organisation 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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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	S	1..*	Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber	Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
identifier:hpii	SC	0..1	AUHPII	Healthcare Provider Identifier – Individual (HPI-I) inv-hpii-0: HPI-I shall be 16 digits inv-hpii-1: HPI-I prefix shall be 800361 inv-hpii-2: HPI-I shall pass the Luhn algorithm check
identifier:caei	SC	1..1	AUCareAgencyEmployeeIdentifier	Care Agency Employee (CAE) Identifier inv-caei-0: CAE identifier shall be 16 digits inv-caei-1: CAE identifier prefix shall be 900360 inv-caei-2: CAE identifier shall pass the Luhn algorithm check
identifier:medicareProvider	S	0..1	AUMedicareProviderNumber	Medicare Provider Number
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	SΣC	1..1	Reference(ADHA Core Practitioner)	Practitioner that is able to provide the defined services for the organization inv-dh-prarol-04: At least a reference, identifier or display shall be present
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
organization	SΣC	1..1	Reference(ADHA Core Organization)	Organization where the roles are available
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
code	SΣ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: Practitioner Role (preferred)
specialty	SΣ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: Clinical Specialty (preferred)
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	SΣ	1..*	ContactPoint	Contact details that are specific to the role/location/service
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PractitionerRole.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
PractitionerRole.practitioner.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
PractitionerRole.organization.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
PractitionerRole.code	preferred	PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 from https://tx.ontoserver.csiro.au/fhir
PractitionerRole.specialty	preferred	ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 from https://tx.ontoserver.csiro.au/fhir
PractitionerRole.availableTime.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

This structure is derived from ADHAPractitionerRoleAuthoring

Summary

Mandatory: 1 element
Must-Support: 1 element

Structures

This structure refers to these other structures:

• AU Care Agency Employee Identifier (http://hl7.org.au/fhir/StructureDefinition/au-careagencyemployeeidentifier)

Other representations of profile: CSV, Excel, Schematron

Notes: