Magentus Practice Management FHIR Implementation Guide
1.2.60 - ci-build Australia flag

Magentus Practice Management FHIR Implementation Guide - Local Development build (v1.2.60) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: EOrders Copy-To PractitionerRole

Official URL: http://fhir.geniesolutions.io/StructureDefinition/eorders-copyto-practitionerrole Version: 1.2.60
Active as of 2026-04-05 Computable Name: EOrdersCopyToPractitionerRole

A profile for representing practitioner role details in the context of a 'copy-to' recipient for diagnostic results. This profile supports the fields captured by Australian clinical systems including Genie and Gentu for address book entries, including secure messaging endpoints and communication preferences.

Examples of this profile are included as contained resources in diagnostic request examples, and a reference to the contained PractitionerRole is used in the result copies-to extension on diagnostic requests. This allows for the inclusion of rich practitioner role information for result recipients, including secure messaging identifiers, while maintaining compatibility with existing systems that may only support a display name for copies-to recipients. See Diagnostic Request, Pathology Request, and Radiology Request profiles and examples for usage of this profile in the context of diagnostic requesting.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* AUBasePractitionerRole A practitioner in a healthcare role in an Australian healthcare context
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:preferredContactMethod S 0..1 CodeableConcept Preferred method of communication (can reference an identifier or telecom system)
URL: http://fhir.geniesolutions.io/StructureDefinition/preferred-contact-method
Binding: Preferred Contact Method Value Set (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier 0..* Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber Business Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
.... identifier:medicareProvider S 0..1 AUMedicareProviderNumber Business Identifiers that are specific to a role/location
.... identifier:medicalObjects S 0..1 EOrdersMedicalObjectsIdentifier Business Identifiers that are specific to a role/location
.... identifier:healthlink S 0..1 EOrdersHealthlinkIdentifier Business Identifiers that are specific to a role/location
.... identifier:argusConnect S 0..1 EOrdersArgusConnectIdentifier Business Identifiers that are specific to a role/location
.... identifier:referralNet S 0..1 EOrdersReferralNetIdentifier Business Identifiers that are specific to a role/location
... practitioner SΣ 0..1 Reference(EOrders Copy-To Practitioner) Reference to contained Practitioner resource
... organization SΣ 0..1 Reference(EOrders Copy-To Organization) Reference to contained Organization resource with HPI-O and address
... specialty SΣ 0..* CodeableConcept Practitioner specialty
Binding: Clinical Specialty . (preferred)
... Slices for telecom SΣ 0..* ContactPoint Contact details that are specific to the role/location/service
Slice: Unordered, Open by value:system, value:use
.... telecom:workPhone SΣ 0..1 ContactPoint Work phone number
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: work
.... telecom:homePhone SΣ 0..1 ContactPoint Home phone number
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: home
.... telecom:mobile SΣ 0..1 ContactPoint Mobile phone number
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: mobile
.... telecom:pager SΣ 0..1 ContactPoint Pager number
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: pager
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... telecom:fax SΣ 0..1 ContactPoint Fax number
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: fax
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: work
.... telecom:email SΣ 0..1 ContactPoint Email address
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: work

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PractitionerRole.specialty Base preferred Clinical Specialty . ⏿1.1.0 tx.hl7.org.au
PractitionerRole.telecom:workPhone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:workPhone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:homePhone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:homePhone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:mobile.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:mobile.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:pager.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:pager.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:fax.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:fax.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error PractitionerRole If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error PractitionerRole If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error PractitionerRole If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error PractitionerRole If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice PractitionerRole A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from AUBasePractitionerRole

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* AUBasePractitionerRole A practitioner in a healthcare role in an Australian healthcare context
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:preferredContactMethod S 0..1 CodeableConcept Preferred method of communication (can reference an identifier or telecom system)
URL: http://fhir.geniesolutions.io/StructureDefinition/preferred-contact-method
Binding: Preferred Contact Method Value Set (extensible)
... Slices for identifier 0..* Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber Business Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
.... identifier:medicareProvider S 0..1 AUMedicareProviderNumber Business Identifiers that are specific to a role/location
.... identifier:medicalObjects S 0..1 EOrdersMedicalObjectsIdentifier Business Identifiers that are specific to a role/location
.... identifier:healthlink S 0..1 EOrdersHealthlinkIdentifier Business Identifiers that are specific to a role/location
.... identifier:argusConnect S 0..1 EOrdersArgusConnectIdentifier Business Identifiers that are specific to a role/location
.... identifier:referralNet S 0..1 EOrdersReferralNetIdentifier Business Identifiers that are specific to a role/location
... practitioner S 0..1 Reference(EOrders Copy-To Practitioner) Reference to contained Practitioner resource
... organization S 0..1 Reference(EOrders Copy-To Organization) Reference to contained Organization resource with HPI-O and address
... specialty S 0..* CodeableConcept Practitioner specialty
... Slices for telecom S 0..* ContactPoint Contact details that are specific to the role/location/service
Slice: Unordered, Open by value:system, value:use
.... telecom:workPhone S 0..1 ContactPoint Work phone number
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... use 1..1 code home | work | temp | old | mobile - purpose of this contact point
Required Pattern: work
.... telecom:homePhone S 0..1 ContactPoint Home phone number
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... use 1..1 code home | work | temp | old | mobile - purpose of this contact point
Required Pattern: home
.... telecom:mobile S 0..1 ContactPoint Mobile phone number
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... use 1..1 code home | work | temp | old | mobile - purpose of this contact point
Required Pattern: mobile
.... telecom:pager S 0..1 ContactPoint Pager number
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: pager
.... telecom:fax S 0..1 ContactPoint Fax number
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: fax
..... use 1..1 code home | work | temp | old | mobile - purpose of this contact point
Required Pattern: work
.... telecom:email S 0..1 ContactPoint Email address
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: email
..... use 1..1 code home | work | temp | old | mobile - purpose of this contact point
Required Pattern: work

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* AUBasePractitionerRole A practitioner in a healthcare role in an Australian healthcare context
... 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 BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:preferredContactMethod S 0..1 CodeableConcept Preferred method of communication (can reference an identifier or telecom system)
URL: http://fhir.geniesolutions.io/StructureDefinition/preferred-contact-method
Binding: Preferred Contact Method Value Set (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier 0..* Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber Business Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
.... identifier:medicareProvider S 0..1 AUMedicareProviderNumber Business Identifiers that are specific to a role/location
.... identifier:medicalObjects S 0..1 EOrdersMedicalObjectsIdentifier Business Identifiers that are specific to a role/location
.... identifier:healthlink S 0..1 EOrdersHealthlinkIdentifier Business Identifiers that are specific to a role/location
.... identifier:argusConnect S 0..1 EOrdersArgusConnectIdentifier Business Identifiers that are specific to a role/location
.... identifier:referralNet S 0..1 EOrdersReferralNetIdentifier Business Identifiers that are specific to a role/location
... active Σ 0..1 boolean Whether this practitioner role record is in active use
... period Σ 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣ 0..1 Reference(EOrders Copy-To Practitioner) Reference to contained Practitioner resource
... organization SΣ 0..1 Reference(EOrders Copy-To Organization) Reference to contained Organization resource with HPI-O and address
... code Σ 0..* CodeableConcept Roles which this practitioner may perform
Binding: Practitioner Role . (preferred)
... specialty SΣ 0..* CodeableConcept Practitioner specialty
Binding: Clinical Specialty . (preferred)
... location Σ 0..* Reference(Location) The location(s) at which this practitioner provides care
... healthcareService 0..* Reference(HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
... Slices for telecom SΣ 0..* ContactPoint Contact details that are specific to the role/location/service
Slice: Unordered, Open by value:system, value:use
.... telecom:workPhone SΣ 0..1 ContactPoint Work phone number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... value Σ 0..1 string The actual contact point details
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: work
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:homePhone SΣ 0..1 ContactPoint Home phone number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... value Σ 0..1 string The actual contact point details
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: home
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:mobile SΣ 0..1 ContactPoint Mobile phone number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... value Σ 0..1 string The actual contact point details
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: mobile
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:pager SΣ 0..1 ContactPoint Pager number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: pager
..... value Σ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:fax SΣ 0..1 ContactPoint Fax number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: fax
..... value Σ 0..1 string The actual contact point details
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: work
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:email SΣ 0..1 ContactPoint Email address
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
..... value Σ 0..1 string The actual contact point details
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: work
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
... 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
...... extension: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
...... extension: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

Path Status Usage ValueSet Version Source
PractitionerRole.language Base preferred Common Languages 📦4.0.1 FHIR Std.
PractitionerRole.code Base preferred Practitioner Role . ⏿1.0.2 tx.hl7.org.au
PractitionerRole.specialty Base preferred Clinical Specialty . ⏿1.1.0 tx.hl7.org.au
PractitionerRole.telecom:workPhone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:workPhone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:homePhone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:homePhone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:mobile.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:mobile.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:pager.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:pager.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:fax.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:fax.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.availableTime.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error PractitionerRole If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error PractitionerRole If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error PractitionerRole If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error PractitionerRole If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice PractitionerRole A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* AUBasePractitionerRole A practitioner in a healthcare role in an Australian healthcare context
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:preferredContactMethod S 0..1 CodeableConcept Preferred method of communication (can reference an identifier or telecom system)
URL: http://fhir.geniesolutions.io/StructureDefinition/preferred-contact-method
Binding: Preferred Contact Method Value Set (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier 0..* Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber Business Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
.... identifier:medicareProvider S 0..1 AUMedicareProviderNumber Business Identifiers that are specific to a role/location
.... identifier:medicalObjects S 0..1 EOrdersMedicalObjectsIdentifier Business Identifiers that are specific to a role/location
.... identifier:healthlink S 0..1 EOrdersHealthlinkIdentifier Business Identifiers that are specific to a role/location
.... identifier:argusConnect S 0..1 EOrdersArgusConnectIdentifier Business Identifiers that are specific to a role/location
.... identifier:referralNet S 0..1 EOrdersReferralNetIdentifier Business Identifiers that are specific to a role/location
... practitioner SΣ 0..1 Reference(EOrders Copy-To Practitioner) Reference to contained Practitioner resource
... organization SΣ 0..1 Reference(EOrders Copy-To Organization) Reference to contained Organization resource with HPI-O and address
... specialty SΣ 0..* CodeableConcept Practitioner specialty
Binding: Clinical Specialty . (preferred)
... Slices for telecom SΣ 0..* ContactPoint Contact details that are specific to the role/location/service
Slice: Unordered, Open by value:system, value:use
.... telecom:workPhone SΣ 0..1 ContactPoint Work phone number
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: work
.... telecom:homePhone SΣ 0..1 ContactPoint Home phone number
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: home
.... telecom:mobile SΣ 0..1 ContactPoint Mobile phone number
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: mobile
.... telecom:pager SΣ 0..1 ContactPoint Pager number
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: pager
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... telecom:fax SΣ 0..1 ContactPoint Fax number
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: fax
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: work
.... telecom:email SΣ 0..1 ContactPoint Email address
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: work

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PractitionerRole.specialty Base preferred Clinical Specialty . ⏿1.1.0 tx.hl7.org.au
PractitionerRole.telecom:workPhone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:workPhone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:homePhone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:homePhone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:mobile.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:mobile.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:pager.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:pager.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:fax.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:fax.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error PractitionerRole If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error PractitionerRole If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error PractitionerRole If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error PractitionerRole If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice PractitionerRole A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from AUBasePractitionerRole

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* AUBasePractitionerRole A practitioner in a healthcare role in an Australian healthcare context
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:preferredContactMethod S 0..1 CodeableConcept Preferred method of communication (can reference an identifier or telecom system)
URL: http://fhir.geniesolutions.io/StructureDefinition/preferred-contact-method
Binding: Preferred Contact Method Value Set (extensible)
... Slices for identifier 0..* Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber Business Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
.... identifier:medicareProvider S 0..1 AUMedicareProviderNumber Business Identifiers that are specific to a role/location
.... identifier:medicalObjects S 0..1 EOrdersMedicalObjectsIdentifier Business Identifiers that are specific to a role/location
.... identifier:healthlink S 0..1 EOrdersHealthlinkIdentifier Business Identifiers that are specific to a role/location
.... identifier:argusConnect S 0..1 EOrdersArgusConnectIdentifier Business Identifiers that are specific to a role/location
.... identifier:referralNet S 0..1 EOrdersReferralNetIdentifier Business Identifiers that are specific to a role/location
... practitioner S 0..1 Reference(EOrders Copy-To Practitioner) Reference to contained Practitioner resource
... organization S 0..1 Reference(EOrders Copy-To Organization) Reference to contained Organization resource with HPI-O and address
... specialty S 0..* CodeableConcept Practitioner specialty
... Slices for telecom S 0..* ContactPoint Contact details that are specific to the role/location/service
Slice: Unordered, Open by value:system, value:use
.... telecom:workPhone S 0..1 ContactPoint Work phone number
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... use 1..1 code home | work | temp | old | mobile - purpose of this contact point
Required Pattern: work
.... telecom:homePhone S 0..1 ContactPoint Home phone number
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... use 1..1 code home | work | temp | old | mobile - purpose of this contact point
Required Pattern: home
.... telecom:mobile S 0..1 ContactPoint Mobile phone number
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... use 1..1 code home | work | temp | old | mobile - purpose of this contact point
Required Pattern: mobile
.... telecom:pager S 0..1 ContactPoint Pager number
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: pager
.... telecom:fax S 0..1 ContactPoint Fax number
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: fax
..... use 1..1 code home | work | temp | old | mobile - purpose of this contact point
Required Pattern: work
.... telecom:email S 0..1 ContactPoint Email address
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: email
..... use 1..1 code home | work | temp | old | mobile - purpose of this contact point
Required Pattern: work

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* AUBasePractitionerRole A practitioner in a healthcare role in an Australian healthcare context
... 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 BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:preferredContactMethod S 0..1 CodeableConcept Preferred method of communication (can reference an identifier or telecom system)
URL: http://fhir.geniesolutions.io/StructureDefinition/preferred-contact-method
Binding: Preferred Contact Method Value Set (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier 0..* Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber Business Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
.... identifier:medicareProvider S 0..1 AUMedicareProviderNumber Business Identifiers that are specific to a role/location
.... identifier:medicalObjects S 0..1 EOrdersMedicalObjectsIdentifier Business Identifiers that are specific to a role/location
.... identifier:healthlink S 0..1 EOrdersHealthlinkIdentifier Business Identifiers that are specific to a role/location
.... identifier:argusConnect S 0..1 EOrdersArgusConnectIdentifier Business Identifiers that are specific to a role/location
.... identifier:referralNet S 0..1 EOrdersReferralNetIdentifier Business Identifiers that are specific to a role/location
... active Σ 0..1 boolean Whether this practitioner role record is in active use
... period Σ 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣ 0..1 Reference(EOrders Copy-To Practitioner) Reference to contained Practitioner resource
... organization SΣ 0..1 Reference(EOrders Copy-To Organization) Reference to contained Organization resource with HPI-O and address
... code Σ 0..* CodeableConcept Roles which this practitioner may perform
Binding: Practitioner Role . (preferred)
... specialty SΣ 0..* CodeableConcept Practitioner specialty
Binding: Clinical Specialty . (preferred)
... location Σ 0..* Reference(Location) The location(s) at which this practitioner provides care
... healthcareService 0..* Reference(HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
... Slices for telecom SΣ 0..* ContactPoint Contact details that are specific to the role/location/service
Slice: Unordered, Open by value:system, value:use
.... telecom:workPhone SΣ 0..1 ContactPoint Work phone number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... value Σ 0..1 string The actual contact point details
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: work
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:homePhone SΣ 0..1 ContactPoint Home phone number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... value Σ 0..1 string The actual contact point details
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: home
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:mobile SΣ 0..1 ContactPoint Mobile phone number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... value Σ 0..1 string The actual contact point details
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: mobile
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:pager SΣ 0..1 ContactPoint Pager number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: pager
..... value Σ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:fax SΣ 0..1 ContactPoint Fax number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: fax
..... value Σ 0..1 string The actual contact point details
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: work
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:email SΣ 0..1 ContactPoint Email address
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
..... value Σ 0..1 string The actual contact point details
..... use ?!Σ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: work
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
... 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
...... extension: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
...... extension: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

Path Status Usage ValueSet Version Source
PractitionerRole.language Base preferred Common Languages 📦4.0.1 FHIR Std.
PractitionerRole.code Base preferred Practitioner Role . ⏿1.0.2 tx.hl7.org.au
PractitionerRole.specialty Base preferred Clinical Specialty . ⏿1.1.0 tx.hl7.org.au
PractitionerRole.telecom:workPhone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:workPhone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:homePhone.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:homePhone.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:mobile.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:mobile.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:pager.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:pager.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:fax.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:fax.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.availableTime.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error PractitionerRole If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error PractitionerRole If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error PractitionerRole If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error PractitionerRole If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice PractitionerRole A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron