AU Patient Summary Implementation Guide
0.6.0-cibuild - 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 0.6.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/freshehr/interopen-uk-fhir-ps/ and changes regularly. See the Directory of published versions

## Resource Profile: AUPSPractitionerRole - Detailed Descriptions

Page standards status: Draft | Maturity Level: 1

Definitions for the au-ps-practitionerrole resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. PractitionerRole
Definition | A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
Short | A person with formal responsibility in a role providing one or more servicesRoles/organizations the practitioner is associated with
Control | 0..*
Is Modifier | false
Complies with Profile | This profile complies with the profile PractitionerRole (IPS)
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. PractitionerRole.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. PractitionerRole.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. PractitionerRole.identifier
Definition | Business Identifiers that are specific to a role/location.
Short | Business Identifiers that are specific to a role/location
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier(Identifier, AU Medicare Provider Number, AU National Provider Identifier At Organisation, AU Employee Number)
Is Modifier | false
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Summary | true
Requirements | Often, specific identities are assigned for the agent.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `PractitionerRole.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ type
8. PractitionerRole.identifier:medicareProvider
Slice Name | medicareProvider
Definition | Business Identifiers that are specific to a role/location.
Short | Business Identifiers that are specific to a role/location
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1*
Type | Identifier(AU Medicare Provider Number)
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Summary | true
Requirements | Often, specific identities are assigned for the agent.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. PractitionerRole.practitioner
Definition | Practitioner that is able to provide the defined services for the organization.
Short | Practitioner that is able to provide the defined services for the organization
Control | 10..1 This element is affected by the following invariants: au-core-prarol-01
Type | Reference(AU PS Practitioner, Practitioner)
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) 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 (`(reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`)
12. PractitionerRole.organization
Definition | The organization where the Practitioner performs the roles associated.
Short | Organization where the roles are available
Control | 0..1
Type | Reference(AU PS Organization, Organization)
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. PractitionerRole.code
Definition | Roles which this practitioner is authorized to perform for the organization.
Short | Roles which this practitioner may perform
Comments | A person may have more than one role.
Control | 0..*
Binding | The codes SHOULD be taken from For example codes, see Practitioner Role http://hl7.org/fhir/ValueSet/practitioner-role|4.0.1 (preferred to `https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1` )
Type | CodeableConcept(Codeable Concept (IPS))
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Summary | true
Requirements | Need to know what authority the practitioner has - what can they do?
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. PractitionerRole.specialty
Definition | Specific specialty of the practitioner.
Short | Specific specialty of the practitioner
Control | 0..*
Binding | The codes SHOULD be taken from Clinical Specialty http://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1 (preferred to `https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1` )
Type | CodeableConcept(Codeable Concept (IPS))
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. PractitionerRole.telecom
Definition | Contact details that are specific to the role/location/service.
Short | Contact details that are specific to the role/location/service
Control | 0..*
Type | ContactPoint
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Summary | true
Requirements | Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. PractitionerRole.telecom.system
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact.
Short | phone | fax | email | pager | url | sms | other
Control | 0..1 This element is affected by the following invariants: cpt-2
Binding | The codes SHALL be taken from ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 (required to `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` ) Telecommunications form for contact point.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. PractitionerRole.telecom.value
Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Short | The actual contact point details
Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
Summary | true
Requirements | Need to support legacy numbers that are not in a tightly controlled format.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. PractitionerRole.telecom.use
Definition | Identifies the purpose for the contact point.
Short | home | work | temp | old | mobile - purpose of this contact point
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Control | 0..1
Binding | The codes SHALL be taken from ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 (required to `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` ) Use of contact point.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. PractitionerRole
Complies with Profile | This profile complies with the profile PractitionerRole (IPS)
2. PractitionerRole.identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
4. PractitionerRole.identifier:medicareProvider
Slice Name | medicareProvider
Note | This is a business identifier, not a resource identifier (see discussion)
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
6. PractitionerRole.practitioner
Type | Reference(AU PS Practitioner)
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
8. PractitionerRole.organization
Type | Reference(AU PS Organization)
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
10. PractitionerRole.code
Type | CodeableConcept(Codeable Concept (IPS))
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
12. PractitionerRole.specialty
Type | CodeableConcept(Codeable Concept (IPS))
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
14. PractitionerRole.telecom
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
16. PractitionerRole.telecom.system
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
18. PractitionerRole.telecom.value
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer

Guidance on how to interpret the contents of this table can be foundhere

0. PractitionerRole
Definition | A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
Short | A person with formal responsibility in a role providing one or more services
Control | 0..*
Is Modifier | false
Complies with Profile | This profile complies with the profile PractitionerRole (IPS)
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (`text.`div`.exists()`)
2. PractitionerRole.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Control | 0..1
Type | id
Is Modifier | false
Summary | true
4. PractitionerRole.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. PractitionerRole.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. PractitionerRole.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages|4.0.1` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. PractitionerRole.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Short | Text summary of the resource, for human interpretation
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Control | 0..1
Type | Narrative
Is Modifier | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. PractitionerRole.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Control | 0..*
Type | Resource
Is Modifier | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
14. PractitionerRole.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
16. PractitionerRole.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
18. PractitionerRole.identifier
Definition | Business Identifiers that are specific to a role/location.
Short | Business Identifiers that are specific to a role/location
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier(Identifier, AU Medicare Provider Number, AU National Provider Identifier At Organisation, AU Employee Number)
Is Modifier | false
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Summary | true
Requirements | Often, specific identities are assigned for the agent.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `PractitionerRole.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ type
20. PractitionerRole.identifier:medicareProvider
Slice Name | medicareProvider
Definition | Business Identifiers that are specific to a role/location.
Short | Business Identifiers that are specific to a role/location
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier(AU Medicare Provider Number)
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Summary | true
Requirements | Often, specific identities are assigned for the agent.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. PractitionerRole.active
Definition | Whether this practitioner role record is in active use.
Short | Whether this practitioner role record is in active use
Comments | If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be able to mark a practitioner role record as not to be used because it was created in error, or otherwise no longer in active use.
Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
24. PractitionerRole.period
Definition | The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
Short | The period during which the practitioner is authorized to perform in these role(s)
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Requirements | Even after the agencies is revoked, the fact that it existed must still be recorded.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. PractitionerRole.practitioner
Definition | Practitioner that is able to provide the defined services for the organization.
Short | Practitioner that is able to provide the defined services for the organization
Control | 1..1 This element is affected by the following invariants: au-core-prarol-01
Type | Reference(AU PS Practitioner)
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 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 (`(reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`)
28. PractitionerRole.organization
Definition | The organization where the Practitioner performs the roles associated.
Short | Organization where the roles are available
Control | 0..1
Type | Reference(AU PS Organization)
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. PractitionerRole.code
Definition | Roles which this practitioner is authorized to perform for the organization.
Short | Roles which this practitioner may perform
Comments | A person may have more than one role.
Control | 0..*
Binding | The codes SHOULD be taken from Practitioner Role (preferred to `https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1` )
Type | CodeableConcept(Codeable Concept (IPS))
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Summary | true
Requirements | Need to know what authority the practitioner has - what can they do?
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
32. PractitionerRole.specialty
Definition | Specific specialty of the practitioner.
Short | Specific specialty of the practitioner
Control | 0..*
Binding | The codes SHOULD be taken from Clinical Specialty (preferred to `https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1` )
Type | CodeableConcept(Codeable Concept (IPS))
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
34. PractitionerRole.location
Definition | The location(s) at which this practitioner provides care.
Short | The location(s) at which this practitioner provides care
Control | 0..*
Type | Reference(Location)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
36. PractitionerRole.healthcareService
Definition | The list of healthcare services that this worker provides for this role's Organization/Location(s).
Short | The list of healthcare services that this worker provides for this role's Organization/Location(s)
Control | 0..*
Type | Reference(HealthcareService)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
38. PractitionerRole.telecom
Definition | Contact details that are specific to the role/location/service.
Short | Contact details that are specific to the role/location/service
Control | 0..*
Type | ContactPoint
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
SHOULD:display | AU PS Consumer
Summary | true
Requirements | Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. PractitionerRole.telecom.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
42. PractitionerRole.telecom.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PractitionerRole.telecom.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
44. PractitionerRole.telecom.system
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact.
Short | phone | fax | email | pager | url | sms | other
Control | 0..1 This element is affected by the following invariants: cpt-2
Binding | The codes SHALL be taken from ContactPointSystem (required to `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` ) Telecommunications form for contact point.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
46. PractitionerRole.telecom.value
Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Short | The actual contact point details
Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | AU PS Producer
SHALL:handle | AU PS Consumer
Summary | true
Requirements | Need to support legacy numbers that are not in a tightly controlled format.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
48. PractitionerRole.telecom.use
Definition | Identifies the purpose for the contact point.
Short | home | work | temp | old | mobile - purpose of this contact point
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Control | 0..1
Binding | The codes SHALL be taken from ContactPointUse (required to `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` ) Use of contact point.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
50. PractitionerRole.telecom.rank
Definition | Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Short | Specify preferred order of use (1 = highest)
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
52. PractitionerRole.telecom.period
Definition | Time period when the contact point was/is in use.
Short | Time period when the contact point was/is in use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
54. PractitionerRole.availableTime
Definition | A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
Short | Times the Service Site is available
Comments | More detailed availability information may be provided in associated Schedule/Slot resources.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
56. PractitionerRole.availableTime.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
58. PractitionerRole.availableTime.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
60. PractitionerRole.availableTime.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
62. PractitionerRole.availableTime.daysOfWeek
Definition | Indicates which days of the week are available between the start and end Times.
Short | mon | tue | wed | thu | fri | sat | sun
Control | 0..*
Binding | The codes SHALL be taken from DaysOfWeek (required to `http://hl7.org/fhir/ValueSet/days-of-week|4.0.1` ) The days of the week.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
64. PractitionerRole.availableTime.allDay
Definition | Is this always available? (hence times are irrelevant) e.g. 24 hour service.
Short | Always available? e.g. 24 hour service
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
66. PractitionerRole.availableTime.availableStartTime
Definition | The opening time of day. Note: If the AllDay flag is set, then this time is ignored.
Short | Opening time of day (ignored if allDay = true)
Comments | The timezone is expected to be for where this HealthcareService is provided at.
Control | 0..1
Type | time
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
68. PractitionerRole.availableTime.availableStartTime.id
Definition | unique id for the element within a resource (for internal references)
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
70. PractitionerRole.availableTime.availableStartTime.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PractitionerRole.availableTime.availableStartTime.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
72. PractitionerRole.availableTime.availableStartTime.extension:timeZone
Slice Name | timeZone
Definition | An IANA timezone code for the timezone offset per BCP 175. For data types allowing the offset (all except date and time), this extension SHALL agree with the offset if provided and cannot be used in place of the offset if the precision expressed requires an offset. Where an offset is provided, this extension provides a more legible display of the zone associated with the offset. Where an offset is not present, this extension can be used to provide zone information not otherwise available.
Short | IANA Timezone Code per BCP 175
Comments | Use Australian Time Zone Usage for Australian state and territory time zone offsets.
Control | 0..1
Type | Extension(Timezone Code) (Extension Type: code)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
74. PractitionerRole.availableTime.availableStartTime.value
Definition | The actual value
Short | Primitive value for time
Control | 0..1
Type | time
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
76. PractitionerRole.availableTime.availableEndTime
Definition | The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
Short | Closing time of day (ignored if allDay = true)
Comments | The timezone is expected to be for where this HealthcareService is provided at.
Control | 0..1
Type | time
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
78. PractitionerRole.availableTime.availableEndTime.id
Definition | unique id for the element within a resource (for internal references)
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
80. PractitionerRole.availableTime.availableEndTime.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PractitionerRole.availableTime.availableEndTime.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
82. PractitionerRole.availableTime.availableEndTime.extension:timeZone
Slice Name | timeZone
Definition | An IANA timezone code for the timezone offset per BCP 175. For data types allowing the offset (all except date and time), this extension SHALL agree with the offset if provided and cannot be used in place of the offset if the precision expressed requires an offset. Where an offset is provided, this extension provides a more legible display of the zone associated with the offset. Where an offset is not present, this extension can be used to provide zone information not otherwise available.
Short | IANA Timezone Code per BCP 175
Comments | Use Australian Time Zone Usage for Australian state and territory time zone offsets.
Control | 0..1
Type | Extension(Timezone Code) (Extension Type: code)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
84. PractitionerRole.availableTime.availableEndTime.value
Definition | The actual value
Short | Primitive value for time
Control | 0..1
Type | time
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
86. PractitionerRole.notAvailable
Definition | The practitioner is not available or performing this role during this period of time due to the provided reason.
Short | Not available during this time due to provided reason
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
88. PractitionerRole.notAvailable.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
90. PractitionerRole.notAvailable.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
92. PractitionerRole.notAvailable.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
94. PractitionerRole.notAvailable.description
Definition | The reason that can be presented to the user as to why this time is not available.
Short | Reason presented to the user explaining why time not available
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
96. PractitionerRole.notAvailable.during
Definition | Service is not available (seasonally or for a public holiday) from this date.
Short | Service not available from this date
Control | 0..1
Type | Period
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
98. PractitionerRole.availabilityExceptions
Definition | A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
Short | Description of availability exceptions
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
100. PractitionerRole.endpoint
Definition | Technical endpoints providing access to services operated for the practitioner with this role.
Short | Technical endpoints providing access to services operated for the practitioner with this role
Control | 0..*
Type | Reference(Endpoint)
Is Modifier | false
Summary | false
Requirements | Organizations have multiple systems that provide various services and ,ay also be different for practitioners too. So the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)