AU Patient Summary Implementation Guide
0.1.0-cibuild - CI Build Australia flag

AU Patient Summary Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 0.1.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/draft-au-patient-summary/ and changes regularly. See the Directory of published versions

Resource Profile: AUPSPractitionerRole - Detailed Descriptions

Page standards status: Informative Maturity Level: 0

Definitions for the au-ps-practitionerrole resource profile.

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

0. PractitionerRole
Impose ProfileThis profile also requires that the instance also conform this additional profile:
2. PractitionerRole.practitioner
TypeReference(AU Patient Summary Practitioner)
4. PractitionerRole.organization
TypeReference(AU Patient Summary Organization)

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

0. PractitionerRole
Definition

A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

ShortA person with formal responsibility in a role providing one or more servicesRoles/organizations the practitioner is associated with
Control0..*
Is Modifierfalse
Impose ProfileThis profile also requires that the instance also conform this additional profile:
Summaryfalse
Invariantsdom-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.

ShortA 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.

Control0..1
Typeuri
Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
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 Namesextensions, user content
Invariantsele-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.

ShortBusiness Identifiers that are specific to a role/location
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
This element is affected by the following invariants: ele-1
TypeIdentifier(Identifier, AU Medicare Provider Number, AU National Provider Identifier At Organisation, AU Employee Number)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Obligations
    ObligationsActor
    SHALL:populate-if-knownhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
    SHALL:no-errorhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
    Requirements

    Often, specific identities are assigned for the agent.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis 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 NamemedicareProvider
      Definition

      Medicare provider number assigned by Services Australia to practitioners who provide services covered by Medicare Benefits Schedule (MBS) at a specific location.


      Business Identifiers that are specific to a role/location.

      ShortMedicare Provider NumberBusiness Identifiers that are specific to a role/location
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..1*
      This element is affected by the following invariants: ele-1
      TypeIdentifier(AU Medicare Provider Number)
      Is Modifierfalse
      Must Supporttrue
      Obligations
        ObligationsActor
        SHALL:populate-if-knownhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
        SHALL:no-errorhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
        Requirements

        Often, specific identities are assigned for the agent.

        Invariantsele-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.

        ShortPractitioner that is able to provide the defined services for the organization
        Control10..1
        This element is affected by the following invariants: au-core-prarol-01
        TypeReference(AU Patient Summary Practitioner, Practitioner)
        Is Modifierfalse
        Must Supporttrue
        Obligations
          ObligationsActor
          SHALL:populate-if-knownhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
          SHALL:no-errorhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
          Summarytrue
          Invariantsele-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.

          ShortOrganization where the roles are available
          Control0..1
          TypeReference(AU Patient Summary Organization, Organization)
          Is Modifierfalse
          Must Supporttrue
          Obligations
            ObligationsActor
            SHALL:populate-if-knownhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
            SHALL:no-errorhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
            Summarytrue
            Invariantsele-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.

            ShortRoles which this practitioner may perform
            Comments

            A person may have more than one role.

            Control0..*
            BindingThe codes SHOULD be taken from For example codes, see Practitioner Role .http://hl7.org/fhir/ValueSet/practitioner-role
            (preferred to https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1)
            TypeCodeableConcept
            Is Modifierfalse
            Must Supporttrue
            Obligations
              ObligationsActor
              SHALL:populate-if-knownhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
              SHALL:no-errorhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
              Summarytrue
              Requirements

              Need to know what authority the practitioner has - what can they do?

              Invariantsele-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.

              ShortSpecific specialty of the practitioner
              Control0..*
              BindingThe codes SHOULD be taken from Clinical Specialty .http://hl7.org/fhir/ValueSet/c80-practice-codes
              (preferred to https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1)
              TypeCodeableConcept
              Is Modifierfalse
              Must Supporttrue
              Obligations
                ObligationsActor
                SHALL:populate-if-knownhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
                SHALL:no-errorhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
                Summarytrue
                Invariantsele-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.

                ShortContact details that are specific to the role/location/service
                Control0..*
                TypeContactPoint
                Is Modifierfalse
                Must Supporttrue
                Obligations
                  ObligationsActor
                  SHALL:populate-if-knownhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
                  SHALL:no-errorhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
                  Summarytrue
                  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.

                  Invariantsele-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 found here

                  0. PractitionerRole
                  Definition

                  A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

                  ShortA person with formal responsibility in a role providing one or more services
                  Control0..*
                  Is Modifierfalse
                  Impose ProfileThis profile also requires that the instance also conform this additional profile:
                  Summaryfalse
                  Invariantsdom-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.

                  ShortLogical 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.

                  Control0..1
                  Typeid
                  Is Modifierfalse
                  Summarytrue
                  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.

                  ShortMetadata about the resource
                  Control0..1
                  TypeMeta
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-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.

                  ShortA 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.

                  Control0..1
                  Typeuri
                  Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Invariantsele-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.

                  ShortLanguage 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).

                  Control0..1
                  BindingThe codes SHOULD be taken from CommonLanguages
                  (preferred to http://hl7.org/fhir/ValueSet/languages)

                  A human language.

                  Additional BindingsPurpose
                  AllLanguagesMax Binding
                  Typecode
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summaryfalse
                  Invariantsele-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.

                  ShortText 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.

                  Control0..1
                  TypeNarrative
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesnarrative, html, xhtml, display
                  Invariantsele-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.

                  ShortContained, 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.

                  Control0..*
                  TypeResource
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesinline 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.

                  ShortAdditional 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.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-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).

                  ShortExtensions 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.

                  Control0..*
                  TypeExtension
                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                  Summaryfalse
                  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 Namesextensions, user content
                  Invariantsele-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.

                  ShortBusiness Identifiers that are specific to a role/location
                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control0..*
                  This element is affected by the following invariants: ele-1
                  TypeIdentifier(Identifier, AU Medicare Provider Number, AU National Provider Identifier At Organisation, AU Employee Number)
                  Is Modifierfalse
                  Must Supporttrue
                  Must Support TypesNo must-support rules about the choice of types/profiles
                  Obligations
                    ObligationsActor
                    SHALL:populate-if-knownhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
                    SHALL:no-errorhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
                    Requirements

                    Often, specific identities are assigned for the agent.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    SlicingThis 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 NamemedicareProvider
                      Definition

                      Medicare provider number assigned by Services Australia to practitioners who provide services covered by Medicare Benefits Schedule (MBS) at a specific location.

                      ShortMedicare Provider Number
                      NoteThis is a business identifier, not a resource identifier (see discussion)
                      Control0..1
                      This element is affected by the following invariants: ele-1
                      TypeIdentifier(AU Medicare Provider Number)
                      Is Modifierfalse
                      Must Supporttrue
                      Obligations
                        ObligationsActor
                        SHALL:populate-if-knownhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
                        SHALL:no-errorhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
                        Requirements

                        Often, specific identities are assigned for the agent.

                        Invariantsele-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.

                        ShortWhether 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.

                        Control0..1
                        Typeboolean
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        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 MissingThis resource is generally assumed to be active if no value is provided for the active element
                        Invariantsele-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.

                        ShortThe period during which the practitioner is authorized to perform in these role(s)
                        Control0..1
                        TypePeriod
                        Is Modifierfalse
                        Summarytrue
                        Requirements

                        Even after the agencies is revoked, the fact that it existed must still be recorded.

                        Invariantsele-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.

                        ShortPractitioner that is able to provide the defined services for the organization
                        Control1..1
                        This element is affected by the following invariants: au-core-prarol-01
                        TypeReference(AU Patient Summary Practitioner)
                        Is Modifierfalse
                        Must Supporttrue
                        Obligations
                          ObligationsActor
                          SHALL:populate-if-knownhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
                          SHALL:no-errorhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
                          Summarytrue
                          Invariantsele-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.

                          ShortOrganization where the roles are available
                          Control0..1
                          TypeReference(AU Patient Summary Organization)
                          Is Modifierfalse
                          Must Supporttrue
                          Obligations
                            ObligationsActor
                            SHALL:populate-if-knownhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
                            SHALL:no-errorhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
                            Summarytrue
                            Invariantsele-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.

                            ShortRoles which this practitioner may perform
                            Comments

                            A person may have more than one role.

                            Control0..*
                            BindingThe codes SHOULD be taken from Practitioner Role .
                            (preferred to https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1)
                            TypeCodeableConcept
                            Is Modifierfalse
                            Must Supporttrue
                            Obligations
                              ObligationsActor
                              SHALL:populate-if-knownhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
                              SHALL:no-errorhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
                              Summarytrue
                              Requirements

                              Need to know what authority the practitioner has - what can they do?

                              Invariantsele-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.

                              ShortSpecific specialty of the practitioner
                              Control0..*
                              BindingThe codes SHOULD be taken from Clinical Specialty .
                              (preferred to https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1)
                              TypeCodeableConcept
                              Is Modifierfalse
                              Must Supporttrue
                              Obligations
                                ObligationsActor
                                SHALL:populate-if-knownhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
                                SHALL:no-errorhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
                                Summarytrue
                                Invariantsele-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.

                                ShortThe location(s) at which this practitioner provides care
                                Control0..*
                                TypeReference(Location)
                                Is Modifierfalse
                                Summarytrue
                                Invariantsele-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).

                                ShortThe list of healthcare services that this worker provides for this role's Organization/Location(s)
                                Control0..*
                                TypeReference(HealthcareService)
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-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.

                                ShortContact details that are specific to the role/location/service
                                Control0..*
                                TypeContactPoint
                                Is Modifierfalse
                                Must Supporttrue
                                Obligations
                                  ObligationsActor
                                  SHALL:populate-if-knownhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
                                  SHALL:no-errorhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
                                  Summarytrue
                                  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.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  40. PractitionerRole.availableTime
                                  Definition

                                  A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.

                                  ShortTimes the Service Site is available
                                  Comments

                                  More detailed availability information may be provided in associated Schedule/Slot resources.

                                  Control0..*
                                  TypeBackboneElement
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  42. 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.

                                  ShortUnique id for inter-element referencing
                                  Control0..1
                                  Typestring
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  44. 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.

                                  ShortAdditional 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.

                                  Control0..*
                                  TypeExtension
                                  Is Modifierfalse
                                  Summaryfalse
                                  Alternate Namesextensions, user content
                                  Invariantsele-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())
                                  46. 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).

                                  ShortExtensions 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.

                                  Control0..*
                                  TypeExtension
                                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                  Summarytrue
                                  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 Namesextensions, user content, modifiers
                                  Invariantsele-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())
                                  48. PractitionerRole.availableTime.daysOfWeek
                                  Definition

                                  Indicates which days of the week are available between the start and end Times.

                                  Shortmon | tue | wed | thu | fri | sat | sun
                                  Control0..*
                                  BindingThe codes SHALL be taken from DaysOfWeek
                                  (required to http://hl7.org/fhir/ValueSet/days-of-week|4.0.1)

                                  The days of the week.

                                  Typecode
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  50. PractitionerRole.availableTime.allDay
                                  Definition

                                  Is this always available? (hence times are irrelevant) e.g. 24 hour service.

                                  ShortAlways available? e.g. 24 hour service
                                  Control0..1
                                  Typeboolean
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  52. PractitionerRole.availableTime.availableStartTime
                                  Definition

                                  The opening time of day. Note: If the AllDay flag is set, then this time is ignored.

                                  ShortOpening time of day (ignored if allDay = true)
                                  Comments

                                  The timezone is expected to be for where this HealthcareService is provided at.

                                  Control0..1
                                  Typetime
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  54. PractitionerRole.availableTime.availableStartTime.id
                                  Definition

                                  unique id for the element within a resource (for internal references)

                                  Shortxml:id (or equivalent in JSON)
                                  Control0..1
                                  Typestring
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  56. PractitionerRole.availableTime.availableStartTime.extension
                                  Definition

                                  An Extension

                                  ShortExtension
                                  Control0..*
                                  TypeExtension
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsele-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())
                                  SlicingThis 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
                                  • 58. PractitionerRole.availableTime.availableStartTime.extension:timeZone
                                    Slice NametimeZone
                                    Definition

                                    Australian time zone.

                                    ShortAU time zone
                                    Control0..1
                                    This element is affected by the following invariants: ele-1
                                    TypeExtension(Australian Time Zone) (Extension Type: CodeableConcept)
                                    Is Modifierfalse
                                    Invariantsele-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.availableStartTime.value
                                    Definition

                                    The actual value

                                    ShortPrimitive value for time
                                    Control0..1
                                    Typetime
                                    Is Modifierfalse
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    62. PractitionerRole.availableTime.availableEndTime
                                    Definition

                                    The closing time of day. Note: If the AllDay flag is set, then this time is ignored.

                                    ShortClosing time of day (ignored if allDay = true)
                                    Comments

                                    The timezone is expected to be for where this HealthcareService is provided at.

                                    Control0..1
                                    Typetime
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    64. PractitionerRole.availableTime.availableEndTime.id
                                    Definition

                                    unique id for the element within a resource (for internal references)

                                    Shortxml:id (or equivalent in JSON)
                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    66. PractitionerRole.availableTime.availableEndTime.extension
                                    Definition

                                    An Extension

                                    ShortExtension
                                    Control0..*
                                    TypeExtension
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-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())
                                    SlicingThis 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
                                    • 68. PractitionerRole.availableTime.availableEndTime.extension:timeZone
                                      Slice NametimeZone
                                      Definition

                                      Australian time zone.

                                      ShortAU time zone
                                      Control0..1
                                      This element is affected by the following invariants: ele-1
                                      TypeExtension(Australian Time Zone) (Extension Type: CodeableConcept)
                                      Is Modifierfalse
                                      Invariantsele-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())
                                      70. PractitionerRole.availableTime.availableEndTime.value
                                      Definition

                                      The actual value

                                      ShortPrimitive value for time
                                      Control0..1
                                      Typetime
                                      Is Modifierfalse
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      Summaryfalse
                                      72. PractitionerRole.notAvailable
                                      Definition

                                      The practitioner is not available or performing this role during this period of time due to the provided reason.

                                      ShortNot available during this time due to provided reason
                                      Control0..*
                                      TypeBackboneElement
                                      Is Modifierfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      74. 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.

                                      ShortUnique id for inter-element referencing
                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      Summaryfalse
                                      76. 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.

                                      ShortAdditional 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.

                                      Control0..*
                                      TypeExtension
                                      Is Modifierfalse
                                      Summaryfalse
                                      Alternate Namesextensions, user content
                                      Invariantsele-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())
                                      78. 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).

                                      ShortExtensions 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.

                                      Control0..*
                                      TypeExtension
                                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                      Summarytrue
                                      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 Namesextensions, user content, modifiers
                                      Invariantsele-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())
                                      80. PractitionerRole.notAvailable.description
                                      Definition

                                      The reason that can be presented to the user as to why this time is not available.

                                      ShortReason presented to the user explaining why time not available
                                      Control1..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      82. PractitionerRole.notAvailable.during
                                      Definition

                                      Service is not available (seasonally or for a public holiday) from this date.

                                      ShortService not available from this date
                                      Control0..1
                                      TypePeriod
                                      Is Modifierfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      84. 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.

                                      ShortDescription of availability exceptions
                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      86. PractitionerRole.endpoint
                                      Definition

                                      Technical endpoints providing access to services operated for the practitioner with this role.

                                      ShortTechnical endpoints providing access to services operated for the practitioner with this role
                                      Control0..*
                                      TypeReference(Endpoint)
                                      Is Modifierfalse
                                      Summaryfalse
                                      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.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))