AU Patient Summary Implementation Guide
1.0.1-ci-build - CI Build
AU Patient Summary Implementation Guide
1.0.1-ci-build - CI Build
AU Patient Summary Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.0.1-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-ps/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-practitionerrole | Version: 1.0.1-ci-build | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: AUPSPractitionerRole | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile sets minimum expectations for a PractitionerRole resource in the context of a patient summary in an Australian context. It is based on the AU Core PractitionerRole profile, and applies the additional requirements from PractitionerRole (IPS).
See Comparison With Other National and International IGs for a comparison between AU Patient Summary (AU PS) profiles and profiles in other implementation guides.
Examples for this Profile: Bundle/aups-basicsummary, Bundle/aups-noknownx, Bundle/aups-referral-endoconsult-curated and Bundle/aups-referral-endoconsult-autogen
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
  PractitionerRole |
0..* | AUCorePractitionerRole | A person with formal responsibility in a role providing one or more services This profile also complies with the profile PractitionerRole (IPS) | |||||||||
  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 |
0..* | Identifier  , AUMedicareProviderNumber , AUNationalProviderIdentifierAtOrganisation , AUEmployeeNumber |
Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||
   identifier:medicareProvider |
0..1 | AUMedicareProviderNumber |
Business Identifiers that are specific to a role/location
| |||||||||
 practitioner |
C | 1..1 | Reference(AU PS Practitioner) | Practitioner that is able to provide the defined services for the organization Constraints: au-core-prarol-01
| ||||||||
| organization |
0..1 | Reference(AU PS Organization) | Organization where the roles are available
| |||||||||
 code |
0..* | CodeableConceptIPS | Roles which this practitioner may perform Binding: Practitioner Role  (preferred)
| |||||||||
| specialty |
0..* | CodeableConceptIPS | Specific specialty of the practitioner Binding: Clinical Specialty (preferred)
| |||||||||
 telecom |
0..* | ContactPoint | Contact details that are specific to the role/location/service
| |||||||||
 system |
C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
| ||||||||
| 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. | |||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| 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.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| PractitionerRole.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| au-core-prarol-01 | error | PractitionerRole.practitioner | At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present |
(reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
|
| 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 AUCorePractitionerRole
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | AUCorePractitionerRole | A person with formal responsibility in a role providing one or more services This profile also complies with the profile PractitionerRole (IPS) | |||||||||
 identifier |
0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location
| |||||||||
| Slices for identifier |
Content/Rules for all slices | |||||||||||
| identifier:medicareProvider |
0..1 | AUMedicareProviderNumber | Business Identifiers that are specific to a role/location
| |||||||||
| practitioner |
1..1 | Reference(AU PS Practitioner) | Practitioner that is able to provide the defined services for the organization
| |||||||||
| organization |
0..1 | Reference(AU PS Organization) | Organization where the roles are available
| |||||||||
| code |
0..* | CodeableConceptIPS | Roles which this practitioner may perform
| |||||||||
| specialty |
0..* | CodeableConceptIPS | Specific specialty of the practitioner
| |||||||||
| telecom |
0..* | ContactPoint | Contact details that are specific to the role/location/service
| |||||||||
| system |
0..1 | code | phone | fax | email | pager | url | sms | other
| |||||||||
| value |
0..1 | string | The actual contact point details
| |||||||||
| Documentation for this format | ||||||||||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | AUCorePractitionerRole | A person with formal responsibility in a role providing one or more services This profile also complies with the profile PractitionerRole (IPS) | |||||||||
| 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.
| |||||||||
| 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 | |||||||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| 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
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||
| identifier:medicareProvider |
0..1 | AUMedicareProviderNumber |
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 |
C | 1..1 | Reference(AU PS Practitioner) | Practitioner that is able to provide the defined services for the organization Constraints: au-core-prarol-01
| ||||||||
| organization |
0..1 | Reference(AU PS Organization) | Organization where the roles are available
| |||||||||
| code |
0..* | CodeableConceptIPS | Roles which this practitioner may perform Binding: Practitioner Role (preferred)
| |||||||||
| specialty |
0..* | CodeableConceptIPS | Specific specialty of the practitioner 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) | |||||||||
| telecom |
0..* | ContactPoint | Contact details that are specific to the role/location/service
| |||||||||
| 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 | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
| ||||||||
| 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 | |||||||||
| 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 | code | IANA Timezone Code per BCP 175 URL: http://hl7.org/fhir/StructureDefinition/timezone Binding: IANATimezones (required): IANA Timezones (BCP 175) | |||||||||
| 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 | code | IANA Timezone Code per BCP 175 URL: http://hl7.org/fhir/StructureDefinition/timezone Binding: IANATimezones (required): IANA Timezones (BCP 175) | |||||||||
| 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 | ||||||||||||
| 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.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| PractitionerRole.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| PractitionerRole.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| au-core-prarol-01 | error | PractitionerRole.practitioner | At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present |
(reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
|
| 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 AUCorePractitionerRole
Summary
Structures
This structure refers to these other structures:
Maturity: 2
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | AUCorePractitionerRole | A person with formal responsibility in a role providing one or more services This profile also complies with the profile PractitionerRole (IPS) | |||||||||
| 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 |
0..* | Identifier , AUMedicareProviderNumber , AUNationalProviderIdentifierAtOrganisation , AUEmployeeNumber |
Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||
| identifier:medicareProvider |
0..1 | AUMedicareProviderNumber |
Business Identifiers that are specific to a role/location
| |||||||||
| practitioner |
C | 1..1 | Reference(AU PS Practitioner) | Practitioner that is able to provide the defined services for the organization Constraints: au-core-prarol-01
| ||||||||
| organization |
0..1 | Reference(AU PS Organization) | Organization where the roles are available
| |||||||||
| code |
0..* | CodeableConceptIPS | Roles which this practitioner may perform Binding: Practitioner Role (preferred)
| |||||||||
| specialty |
0..* | CodeableConceptIPS | Specific specialty of the practitioner Binding: Clinical Specialty (preferred)
| |||||||||
| telecom |
0..* | ContactPoint | Contact details that are specific to the role/location/service
| |||||||||
| system |
C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
| ||||||||
| 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. | |||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| 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.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| PractitionerRole.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| au-core-prarol-01 | error | PractitionerRole.practitioner | At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present |
(reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
|
| 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 AUCorePractitionerRole
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | AUCorePractitionerRole | A person with formal responsibility in a role providing one or more services This profile also complies with the profile PractitionerRole (IPS) | |||||||||
| identifier |
0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location
| |||||||||
| Slices for identifier |
Content/Rules for all slices | |||||||||||
| identifier:medicareProvider |
0..1 | AUMedicareProviderNumber | Business Identifiers that are specific to a role/location
| |||||||||
| practitioner |
1..1 | Reference(AU PS Practitioner) | Practitioner that is able to provide the defined services for the organization
| |||||||||
| organization |
0..1 | Reference(AU PS Organization) | Organization where the roles are available
| |||||||||
| code |
0..* | CodeableConceptIPS | Roles which this practitioner may perform
| |||||||||
| specialty |
0..* | CodeableConceptIPS | Specific specialty of the practitioner
| |||||||||
| telecom |
0..* | ContactPoint | Contact details that are specific to the role/location/service
| |||||||||
| system |
0..1 | code | phone | fax | email | pager | url | sms | other
| |||||||||
| value |
0..1 | string | The actual contact point details
| |||||||||
| Documentation for this format | ||||||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | AUCorePractitionerRole | A person with formal responsibility in a role providing one or more services This profile also complies with the profile PractitionerRole (IPS) | |||||||||
| 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.
| |||||||||
| 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 | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| 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
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||
| identifier:medicareProvider |
0..1 | AUMedicareProviderNumber |
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 |
C | 1..1 | Reference(AU PS Practitioner) | Practitioner that is able to provide the defined services for the organization Constraints: au-core-prarol-01
| ||||||||
| organization |
0..1 | Reference(AU PS Organization) | Organization where the roles are available
| |||||||||
| code |
0..* | CodeableConceptIPS | Roles which this practitioner may perform Binding: Practitioner Role (preferred)
| |||||||||
| specialty |
0..* | CodeableConceptIPS | Specific specialty of the practitioner 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) | |||||||||
| telecom |
0..* | ContactPoint | Contact details that are specific to the role/location/service
| |||||||||
| 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 | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
| ||||||||
| 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 | |||||||||
| 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 | code | IANA Timezone Code per BCP 175 URL: http://hl7.org/fhir/StructureDefinition/timezone Binding: IANATimezones (required): IANA Timezones (BCP 175) | |||||||||
| 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 | code | IANA Timezone Code per BCP 175 URL: http://hl7.org/fhir/StructureDefinition/timezone Binding: IANATimezones (required): IANA Timezones (BCP 175) | |||||||||
| 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 | ||||||||||||
| 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.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| PractitionerRole.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| PractitionerRole.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| au-core-prarol-01 | error | PractitionerRole.practitioner | At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present |
(reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
|
| 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 AUCorePractitionerRole
Summary
Structures
This structure refers to these other structures:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ HL7 Australia. Package hl7.fhir.au.ps#1.0.1-ci-build based on FHIR 4.0.1. Generated 2026-10-11
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change