AU Core Implementation Guide
1.0.0-ci-build - CI Build
AU Core Implementation Guide
1.0.0-ci-build - CI Build
AU Core Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.0.0-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-core/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole | Version: 1.0.0-ci-build | |||
| Standards status: Draft | Maturity Level: 1 | Computable Name: AUCorePractitionerRole | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile sets minimum expectations for a PractitionerRole resource to record, search, and fetch a practitioner role for a practitioner associated with a patient. It is based on the AU Base Practitioner Role profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the PractitionerRole resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.
See Comparison with other national and international IGs for a comparison between AU Core profiles and profiles in other implementation guides.
The following are supported usage scenarios for this profile:
_include, see the Notes section below.Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBasePractitionerRole
| Name | Flags | Card. | Type | Description & Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
  PractitionerRole |
0..* | AUBasePractitionerRole | A person with formal responsibility in a role providing one or more services | |||||||
  Slices for identifier |
SO | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
| ||||||
   identifier:medicareProvider |
SO | 0..1 | AUMedicareProviderNumber | Medicare Provider Number
| ||||||
  practitioner |
SOC | 1..1 | Reference(AU Core Practitioner) | Practitioner that is able to provide the defined services for the organization au-core-prarol-01: At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present
| ||||||
| organization |
SO | 0..1 | Reference(AU Core Organization) | Organization where the roles are available
| ||||||
 code |
SO | 0..* | CodeableConcept | Roles which this practitioner may perform
| ||||||
| specialty |
SO | 0..* | CodeableConcept | Specific specialty of the practitioner
| ||||||
 telecom |
SO | 0..* | ContactPoint | Contact details that are specific to the role/location/service
| ||||||
| Documentation for this format | ||||||||||
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | AUBasePractitionerRole | A person with formal responsibility in a role providing one or more services | |||||||
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
| Slices for identifier |
SO | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
| ||||||
| identifier:medicareProvider |
SO | 0..1 | AUMedicareProviderNumber | Medicare Provider Number
| ||||||
| practitioner |
SOΣC | 1..1 | Reference(AU Core Practitioner) | Practitioner that is able to provide the defined services for the organization au-core-prarol-01: At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present
| ||||||
| organization |
SOΣ | 0..1 | Reference(AU Core Organization) | Organization where the roles are available
| ||||||
 code |
SOΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role  (preferred)
| ||||||
| specialty |
SOΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Clinical Specialty (preferred)
| ||||||
| telecom |
SOΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service
| ||||||
| Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI |
| PractitionerRole.code | preferred | PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | |
| PractitionerRole.specialty | preferred | ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | AUBasePractitionerRole | A person with formal responsibility in a role providing one or more services | |||||||
| 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 | |||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
| Slices for identifier |
SO | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
| ||||||
| identifier:medicareProvider |
SO | 0..1 | AUMedicareProviderNumber | Medicare Provider Number
| ||||||
| 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 |
SOΣC | 1..1 | Reference(AU Core Practitioner) | Practitioner that is able to provide the defined services for the organization au-core-prarol-01: At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present
| ||||||
| organization |
SOΣ | 0..1 | Reference(AU Core Organization) | Organization where the roles are available
| ||||||
| code |
SOΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (preferred)
| ||||||
| specialty |
SOΣ | 0..* | CodeableConcept | 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 |
SOΣ | 0..* | 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 | ||||||||||
| Path | Conformance | ValueSet | URI | |||
| PractitionerRole.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| PractitionerRole.code | preferred | PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | ||||
| PractitionerRole.specialty | preferred | ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 | ||||
| PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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 AUBasePractitionerRole
Summary
Mandatory: 1 element
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 1
Differential View
This structure is derived from AUBasePractitionerRole
| Name | Flags | Card. | Type | Description & Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | AUBasePractitionerRole | A person with formal responsibility in a role providing one or more services | |||||||
| Slices for identifier |
SO | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
| ||||||
| identifier:medicareProvider |
SO | 0..1 | AUMedicareProviderNumber | Medicare Provider Number
| ||||||
| practitioner |
SOC | 1..1 | Reference(AU Core Practitioner) | Practitioner that is able to provide the defined services for the organization au-core-prarol-01: At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present
| ||||||
| organization |
SO | 0..1 | Reference(AU Core Organization) | Organization where the roles are available
| ||||||
| code |
SO | 0..* | CodeableConcept | Roles which this practitioner may perform
| ||||||
| specialty |
SO | 0..* | CodeableConcept | Specific specialty of the practitioner
| ||||||
| telecom |
SO | 0..* | ContactPoint | Contact details that are specific to the role/location/service
| ||||||
| Documentation for this format | ||||||||||
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | AUBasePractitionerRole | A person with formal responsibility in a role providing one or more services | |||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
| Slices for identifier |
SO | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
| ||||||
| identifier:medicareProvider |
SO | 0..1 | AUMedicareProviderNumber | Medicare Provider Number
| ||||||
| practitioner |
SOΣC | 1..1 | Reference(AU Core Practitioner) | Practitioner that is able to provide the defined services for the organization au-core-prarol-01: At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present
| ||||||
| organization |
SOΣ | 0..1 | Reference(AU Core Organization) | Organization where the roles are available
| ||||||
| code |
SOΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (preferred)
| ||||||
| specialty |
SOΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Clinical Specialty (preferred)
| ||||||
| telecom |
SOΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service
| ||||||
| Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI |
| PractitionerRole.code | preferred | PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | |
| PractitionerRole.specialty | preferred | ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | AUBasePractitionerRole | A person with formal responsibility in a role providing one or more services | |||||||
| 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 | |||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
| Slices for identifier |
SO | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
| ||||||
| identifier:medicareProvider |
SO | 0..1 | AUMedicareProviderNumber | Medicare Provider Number
| ||||||
| 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 |
SOΣC | 1..1 | Reference(AU Core Practitioner) | Practitioner that is able to provide the defined services for the organization au-core-prarol-01: At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present
| ||||||
| organization |
SOΣ | 0..1 | Reference(AU Core Organization) | Organization where the roles are available
| ||||||
| code |
SOΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (preferred)
| ||||||
| specialty |
SOΣ | 0..* | CodeableConcept | 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 |
SOΣ | 0..* | 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 | ||||||||||
| Path | Conformance | ValueSet | URI | |||
| PractitionerRole.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| PractitionerRole.code | preferred | PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | ||||
| PractitionerRole.specialty | preferred | ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 | ||||
| PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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 AUBasePractitionerRole
Summary
Mandatory: 1 element
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU Core CapabilityStatements for a complete list of supported RESTful interactions for this IG.
FHIR search operations are described here and the syntax used to describe AU Core interactions is defined here.
Any search parameter defined in FHIR may be 'allowed' by the system unless explicitly marked as "SHALL NOT". A few items are marked as MAY in this implementation guide to highlight their potential relevance.
| Parameter(s) | Conformance | Type(s) | Requirements (when used alone or in combination) |
|---|---|---|---|
| identifier | SHALL | token |
The requester SHALL provide at least a code value and SHOULD provide both the system and code values. The responder SHALL support both. The requester SHOULD support search using a Medicare Provider Number identifier as defined in the profile. The responder SHOULD support search using a Medicare Provider Number identifier as defined in the profile. |
| practitioner | SHALL | reference |
The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder SHALL support both. |
| _id | SHOULD | token |
|
| practitioner.identifier | SHOULD | token |
The requester SHALL provide at least a code value and SHOULD provide both the system and code values. The responder SHALL support both. The requester SHOULD support search using a HPI-I identifier as defined in the AU Core Practitioner profile. The responder SHOULD support search using the using a HPI-I identifier as defined in the AU Core Practitioner profile. |
| specialty | SHOULD | token |
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
| organization | MAY | reference |
The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder SHALL support both. |
The following search parameters SHALL be supported:
identifier search parameter:
_include parameters: PractitionerRole:practitionerGET [base]/PractitionerRole?identifier={system|}[code]
Example:
Implementation Notes: Fetches a bundle containing any PractitionerRole resources matching the identifier (how to search by token)
practitioner search parameters:
practitioner.identifier (e.g. practitioner.identifier=[system|][code])_include parameters: PractitionerRole:practitionerGET [base]/PractitionerRole?practitioner={Type/}[id]
or optionally GET [base]/PractitionerRole?practitioner.identifier=[system|][code]
Example:
Implementation Notes: Fetches a bundle of all PractitionerRole resources matching the specified practitioner (how to search by reference and how to search by token)
The following search parameters and search parameter combinations SHOULD be supported:
_id search parameter:
_include parameters: PractitionerRole:practitionerGET [base]/PractitionerRole?_id=[id]
Example:
Implementation Notes: Fetches a bundle with the requested PractitionerRole, instead of just the resource itself, and allows for the inclusion of additional search parameters such as _include, _revinclude, or _lastUpdated (how to search by id of the resource)
specialty search parameter:
_include parameters: PractitionerRole:practitionerGET [base]/PractitionerRole?specialty={system|}[code]
Example:
Implementation Notes: Fetches a bundle of all PractitionerRole resources for the specified specialty (how to search by token)
IG © 2022+ HL7 Australia. Package hl7.fhir.au.core#1.0.0-ci-build based on FHIR 4.0.1. Generated 2024-10-01
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change