Magentus Practice Management FHIR Implementation Guide
1.2.16 - ci-build

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

Resource Profile: GSImagingReportEntryProvider - Detailed Descriptions

Draft as of 2024-08-15

Definitions for the gs-imagingreport-entry-provider resource profile.

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

0. PractitionerRole
2. PractitionerRole.contained
Control1..?
Must Supporttrue
SlicingThis element introduces a set of slices on PractitionerRole.contained. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
  • 4. PractitionerRole.contained:practitioner
    Slice Namepractitioner
    Control1..1
    TypePractitioner(AU Core Practitioner)
    Must Supporttrue
    6. PractitionerRole.contained:practitioner.name
    ShortRequester name
    Control0..1
    8. PractitionerRole.contained:practitioner.name.family
    Control1..?
    10. PractitionerRole.contained:practitioner.name.given
    Control1..1
    12. PractitionerRole.contained:organization
    Slice Nameorganization
    Control0..1
    TypeOrganization(AU Core Organization)
    Must Supporttrue
    14. PractitionerRole.contained:organization.name
    ShortRequester site name
    16. PractitionerRole.identifier:employeeNumber
    Slice NameemployeeNumber
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1
    TypeIdentifier(AU Employee Number)
    18. PractitionerRole.practitioner
    20. PractitionerRole.practitioner.reference
    ShortReference to contained Practitioner resource
    Control1..?
    22. PractitionerRole.organization
    24. PractitionerRole.organization.reference
    ShortReference to contained Organization resource
    Control1..?

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

    Control10..*
    TypeResource
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Alternate Namesinline resources, anonymous resources, contained resources
    SlicingThis element introduces a set of slices on PractitionerRole.contained. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • type @ $this
    • 6. PractitionerRole.contained:practitioner
      Slice Namepractitioner
      Definition

      A person who is directly or indirectly involved in the provisioning of healthcare.


      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.

      ShortA person with a formal responsibility in the provisioning of servicesContained, 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.

      Control10..1*
      TypePractitionerResource(AU Core Practitioner)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Alternate Namesinline resources, anonymous resources, contained resources
      8. PractitionerRole.contained:practitioner.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()))
      10. PractitionerRole.contained:practitioner.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())
      12. PractitionerRole.contained:practitioner.identifier
      Definition

      An identifier that applies to this person in this role.

      ShortAn identifier intended for computationAn identifier for the person as this agent
      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 HPI-I, AU PBS Prescriber Number, AU Care Agency Employee Identifier, AU Ahpra Registration Number)
      Is Modifierfalse
      Must Supporttrue
      Must Support TypesNo must-support rules about the choice of types/profiles
      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.contained.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • pattern @ type
      • 14. PractitionerRole.contained:practitioner.identifier:hpii
        Slice Namehpii
        Definition

        Healthcare Provider Identifier for Individuals (HPI-I) assigned under the HI Service to healthcare providers involved in providing patient care.


        An identifier that applies to this person in this role.

        ShortHealthcare Provider Identifier – Individual (HPI-I)An identifier for the person as this agent
        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 HPI-I)
        Is Modifierfalse
        Must Supporttrue
        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()))
        inv-hpii-0: HPI-I shall be 16 digits (value.matches('^([0-9]{16})$'))
        inv-hpii-1: HPI-I prefix shall be 800361 (value.startsWith('800361'))
        inv-hpii-2: HPI-I shall pass the Luhn algorithm check ((((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0))
        16. PractitionerRole.contained:practitioner.name
        Definition

        The name(s) associated with the practitioner.

        ShortRequester nameThe name(s) associated with the practitioner
        Comments

        The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate.

        In general, select the value to be used in the ResourceReference.display based on this:

        1. There is more than 1 name
        2. Use = usual
        3. Period is current to the date of the usage
        4. Use = official
        5. Other order as decided by internal business rules.
        Control10..1*
        This element is affected by the following invariants: au-core-prac-01
        TypeHumanName
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Requirements

        The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        au-core-prac-01: At least text or family name shall be present (text.exists() or family.exists())
        18. PractitionerRole.contained:practitioner.name.use
        Definition

        Identifies the purpose for this name.

        Shortusual | official | temp | nickname | anonymous | old | maiden
        Comments

        Applications can assume that a name is current unless it explicitly says that it is temporary or old.

        Control0..1
        BindingThe codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1
        (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

        The use of a human name.

        Typecode
        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Allows the appropriate name for a particular context of use to be selected from among a set of names.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        20. PractitionerRole.contained:practitioner.name.family
        Definition

        The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

        ShortFamily name (often called 'Surname')
        Comments

        Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

        Control10..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Alternate Namessurname
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        22. PractitionerRole.contained:practitioner.name.given
        Definition

        Given name.

        ShortGiven names (not always 'first'). Includes middle names
        Comments

        If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

        Control10..1*
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Alternate Namesfirst name, middle name
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        24. PractitionerRole.contained:practitioner.telecom
        Definition

        A contact detail for the practitioner, e.g. a telephone number or an email address.

        ShortA contact detail for the practitioner (that apply to all roles)
        Comments

        Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.

        Control0..*
        TypeContactPoint
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Requirements

        Need to know how to reach a practitioner independent to any roles the practitioner may have.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        26. PractitionerRole.contained:practitioner.address
        Definition

        An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.


        Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.

        ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)Address(es) of the practitioner that are not role specific (typically home address)
        Comments

        The address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).


        The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).

        Control0..*
        This element is affected by the following invariants: ele-1
        TypeAddress(Address, Australian Address)
        Is Modifierfalse
        Must Supporttrue
        Must Support TypesNo must-support rules about the choice of types/profiles
        Requirements

        The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        28. PractitionerRole.contained:practitioner.qualification
        Definition

        The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.

        ShortCertification, licenses, or training pertaining to the provision of care
        Control0..*
        TypeBackboneElement
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        inv-pra-0: A qualification shall only have Ahpra Profession details if the code is Ahpra Profession (extension('http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details').exists() implies code.coding.where(system='http://terminology.hl7.org.au/CodeSystem/v2-0360' and code='AUAHPRAProfession').exists())
        inv-pra-1: A qualification shall only have Ahpra Registration details if the code is Ahpra Registration (extension('http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details').exists() implies code.coding.where(system='http://terminology.hl7.org.au/CodeSystem/v2-0360' and code='AUAHPRARegistration').exists())
        30. PractitionerRole.contained:practitioner.qualification.extension:ahpraProfession-details
        Slice NameahpraProfession-details
        Definition

        An Extension

        ShortAhpra Profession Details
        Control0..1
        This element is affected by the following invariants: ele-1, inv-pra-0
        TypeExtension(Ahpra Profession Details) (Complex Extension)
        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())
        32. PractitionerRole.contained:practitioner.qualification.extension:ahpraRegistration-details
        Slice NameahpraRegistration-details
        Definition

        Details on the Ahpra registration of profession.

        ShortAhpra Registration Details
        Control0..1
        This element is affected by the following invariants: ele-1, inv-pat-1
        TypeExtension(Ahpra Registration Details) (Complex Extension)
        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())
        34. PractitionerRole.contained:practitioner.qualification.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())
        36. PractitionerRole.contained:practitioner.qualification.identifier
        Definition

        An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.


        An identifier that applies to this person's qualification in this role.

        ShortAn identifier intended for computationAn identifier for this qualification for the practitioner
        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 Ahpra Registration Number)
        Is Modifierfalse
        Must Supporttrue
        Must Support TypesNo must-support rules about the choice of types/profiles
        Requirements

        Often, specific identities are assigned for the qualification.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        38. PractitionerRole.contained:practitioner.qualification.code
        Definition

        Coded representation of the qualification.

        ShortCoded representation of the qualification
        Control1..1
        This element is affected by the following invariants: inv-pra-0, inv-pat-1
        BindingThe codes SHOULD be taken from For example codes, see hl7VS-degreeLicenseCertificate - AU Extendedhttp://terminology.hl7.org/ValueSet/v2-2.7-0360
        (preferred to http://terminology.hl7.org.au/ValueSet/v2-0360-extended)
        TypeCodeableConcept
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        40. PractitionerRole.contained:practitioner.qualification.period
        Definition

        Period during which the qualification is valid.

        ShortPeriod during which the qualification is valid
        Control0..1
        TypePeriod
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Requirements

        Qualifications are often for a limited period of time, and can be revoked.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        42. PractitionerRole.contained:practitioner.qualification.issuer
        Definition

        Organization that regulates and issues the qualification.

        ShortOrganization that regulates and issues the qualification
        Control0..1
        TypeReference(Organization)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        44. PractitionerRole.contained:practitioner.communication
        Definition

        A language the practitioner can use in patient communication.

        ShortA language the practitioner can use in patient communication
        Comments

        The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

        Control0..*
        BindingUnless not suitable, these codes SHALL be taken from The codes SHOULD be taken from Common Languages in Australia .http://hl7.org/fhir/ValueSet/languages
        (extensible to https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2)
        TypeCodeableConcept
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Requirements

        Knowing which language a practitioner speaks can help in facilitating communication with patients.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        46. PractitionerRole.contained:organization
        Slice Nameorganization
        Definition

        A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.


        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.

        ShortAn organisation in an Australian healthcare contextContained, 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..1*
        TypeOrganizationResource(AU Core Organization)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Alternate Namesinline resources, anonymous resources, contained resources
        48. PractitionerRole.contained:organization.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()))
        50. PractitionerRole.contained:organization.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())
        52. PractitionerRole.contained:organization.identifier
        Definition

        Identifier for the organization that is used to identify the organization across multiple disparate systems.

        ShortIdentifies this organization across multiple systemsIdentifies this organization across multiple systems
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..*
        This element is affected by the following invariants: ele-1, au-core-org-01, org-1
        TypeIdentifier(Identifier, AU HPI-O, AU PAI-O Identifier, AU CSP Registration Number, AU Australian Business Number, AU Australian Company Number, AU Australian Registered Body Number, AU NATA Accreditation Number, AU Pharmacy Approval Number)
        Is Modifierfalse
        Must Supporttrue
        Must Support TypesNo must-support rules about the choice of types/profiles
        Requirements

        Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O (where(type.coding.code = 'NOI').exists() implies (system='http://ns.electronichealth.net.au/id/hi/hpio/1.0') or (system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0'))
        SlicingThis element introduces a set of slices on PractitionerRole.contained.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • pattern @ system
        • 54. PractitionerRole.contained:organization.identifier:hpio
          Slice Namehpio
          Definition

          Healthcare Provider Identifier – Organisation (HPI-O) assigned under the HI Service to an organisation (such as a hospital or medical clinic) where healthcare is provided.


          Identifier for the organization that is used to identify the organization across multiple disparate systems.

          ShortHealthcare Provider Identifier – Organisation (HPI-O)Identifies this organization across multiple systems
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..1*
          This element is affected by the following invariants: ele-1, org-1
          TypeIdentifier(AU HPI-O)
          Is Modifierfalse
          Must Supporttrue
          Requirements

          Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          inv-hpio-0: HPI-O shall be 16 digits (value.matches('^([0-9]{16})$'))
          inv-hpio-1: HPI-O prefix shall be 800362 (value.startsWith('800362'))
          inv-hpio-2: HPI-O shall pass the Luhn algorithm check ((((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0))
          56. PractitionerRole.contained:organization.identifier:abn
          Slice Nameabn
          Definition

          Australian Business Number (ABN) assigned by the Australian Securities and Investment Commission (ASIC) to an entity registered in the Australian Business Register (ABR).


          Identifier for the organization that is used to identify the organization across multiple disparate systems.

          ShortAustralian Business Number (ABN)Identifies this organization across multiple systems
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..*
          This element is affected by the following invariants: ele-1, org-1
          TypeIdentifier(AU Australian Business Number)
          Is Modifierfalse
          Must Supporttrue
          Requirements

          Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          inv-abn-0: ABN shall be 11 digits (value.matches('^([0-9]{11})$'))
          58. PractitionerRole.contained:organization.active
          Definition

          Whether the organization's record is still in active use.

          ShortWhether the organization's record is still in active use
          Comments

          This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.

          This element is labeled as a modifier because it may be used to mark that the resource was created in error.

          Control0..1
          Typeboolean
          Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

          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()))
          60. PractitionerRole.contained:organization.type
          Definition

          The kind(s) of organization that this is.

          ShortKind of organization
          Comments

          When selecting a code for Organization type, if a system is unable to provide a code from the preferred value set Healthcare Organisation Role Type because the implementation context is not restricted to healthcare practitioner providers then it is recommended to select from the wider set available in SNOMED CT. If a suitable code from SNOMED CT is not available, a code from the code system Australian and New Zealand Standard Industrial Classification (ANZSIC), 2006 (Revision 2.0) may be used.


          Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes

          When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.

          We expect that some jurisdictions will profile this optionality to be a single cardinality.

          Control0..*
          BindingThe codes SHOULD be taken from For example codes, see Healthcare Organisation Role Type .http://hl7.org/fhir/ValueSet/organization-type
          (preferred to https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1)
          TypeCodeableConcept
          Is Modifierfalse
          Must Supporttrue
          Summarytrue
          Requirements

          Need to be able to track the kind of organization that this is - different organization types have different uses.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          62. PractitionerRole.contained:organization.name
          Definition

          A name associated with the organization.

          ShortRequester site nameName used for the organization
          Comments

          If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.

          Control10..1
          This element is affected by the following invariants: org-1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Requirements

          Need to use the name as the label of the organization.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          64. PractitionerRole.contained:organization.alias
          Definition

          A list of alternate names that the organization is known as, or was known as in the past.

          ShortA list of alternate names that the organization is known as, or was known as in the past
          Comments

          There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.

          Control0..*
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summaryfalse
          Requirements

          Over time locations and organizations go through many changes and can be known by different names.

          For searching knowing previous names that the organization was known by can be very useful.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          66. PractitionerRole.contained:organization.telecom
          Definition

          A contact detail for the organization.

          ShortA contact detail for the organization
          Comments

          The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

          Control0..*
          This element is affected by the following invariants: org-3
          TypeContactPoint
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Requirements

          Human contact for the organization.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
          org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
          68. PractitionerRole.contained:organization.address
          Definition

          An address for the organization.

          ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)An address for the organization
          Comments

          The address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).


          Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.

          Control0..*
          This element is affected by the following invariants: ele-1, org-2
          TypeAddress(Address, Australian Address)
          Is Modifierfalse
          Must Supporttrue
          Must Support TypesNo must-support rules about the choice of types/profiles
          Requirements

          May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())
          org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())
          70. 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())
          72. 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
          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
          • 74. 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
            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()))
            76. PractitionerRole.identifier:employeeNumber
            Slice NameemployeeNumber
            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..1*
            This element is affected by the following invariants: ele-1
            TypeIdentifier(AU Employee Number)
            Is Modifierfalse
            Must Supporttrue
            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()))
            78. 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 Core Practitioner, Practitioner)
            Is Modifierfalse
            Must Supporttrue
            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 (reference.exists() or identifier.exists() or display.exists())
            80. PractitionerRole.practitioner.reference
            Definition

            A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

            ShortReference to contained Practitioner resourceLiteral reference, Relative, internal or absolute URL
            Comments

            Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

            Control10..1
            This element is affected by the following invariants: ref-1
            Typestring
            Is Modifierfalse
            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()))
            82. PractitionerRole.organization
            Definition

            The organization where the Practitioner performs the roles associated.

            ShortOrganization where the roles are available
            Control0..1
            TypeReference(AU Core Organization, Organization)
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            84. PractitionerRole.organization.reference
            Definition

            A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

            ShortReference to contained Organization resourceLiteral reference, Relative, internal or absolute URL
            Comments

            Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

            Control10..1
            This element is affected by the following invariants: ref-1
            Typestring
            Is Modifierfalse
            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()))
            86. 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
            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()))
            88. 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
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            90. PractitionerRole.location
            Definition

            The location(s) at which this practitioner provides care.

            ShortThe location(s) at which this practitioner provides care
            Control0..*
            TypeReference(AU Core Location, Location)
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            92. 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
            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
            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.

            Control1..*
            TypeResource
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Alternate Namesinline resources, anonymous resources, contained resources
            SlicingThis element introduces a set of slices on PractitionerRole.contained. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • type @ $this
            • 14. PractitionerRole.contained:practitioner
              Slice Namepractitioner
              Definition

              A person who is directly or indirectly involved in the provisioning of healthcare.

              ShortA person with a formal responsibility in the provisioning of services
              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.

              Control1..1
              TypePractitioner(AU Core Practitioner)
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              16. PractitionerRole.contained:practitioner.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
              18. PractitionerRole.contained:practitioner.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()))
              20. PractitionerRole.contained:practitioner.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()))
              22. PractitionerRole.contained:practitioner.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()))
              24. PractitionerRole.contained:practitioner.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()))
              26. PractitionerRole.contained:practitioner.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
              28. PractitionerRole.contained:practitioner.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())
              30. PractitionerRole.contained:practitioner.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())
              32. PractitionerRole.contained:practitioner.identifier
              Definition

              An identifier that applies to this person in this role.

              ShortAn identifier intended for computation
              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 HPI-I, AU PBS Prescriber Number, AU Care Agency Employee Identifier, AU Ahpra Registration Number)
              Is Modifierfalse
              Must Supporttrue
              Must Support TypesNo must-support rules about the choice of types/profiles
              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.contained.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • pattern @ type
              • 34. PractitionerRole.contained:practitioner.identifier:hpii
                Slice Namehpii
                Definition

                Healthcare Provider Identifier for Individuals (HPI-I) assigned under the HI Service to healthcare providers involved in providing patient care.

                ShortHealthcare Provider Identifier – Individual (HPI-I)
                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 HPI-I)
                Is Modifierfalse
                Must Supporttrue
                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()))
                inv-hpii-0: HPI-I shall be 16 digits (value.matches('^([0-9]{16})$'))
                inv-hpii-1: HPI-I prefix shall be 800361 (value.startsWith('800361'))
                inv-hpii-2: HPI-I shall pass the Luhn algorithm check ((((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0))
                36. PractitionerRole.contained:practitioner.active
                Definition

                Whether this practitioner's record is in active use.

                ShortWhether this practitioner's record is in active use
                Comments

                If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.

                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 record as not to be used because it was created in error.

                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()))
                38. PractitionerRole.contained:practitioner.name
                Definition

                The name(s) associated with the practitioner.

                ShortRequester name
                Comments

                The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate.

                In general, select the value to be used in the ResourceReference.display based on this:

                1. There is more than 1 name
                2. Use = usual
                3. Period is current to the date of the usage
                4. Use = official
                5. Other order as decided by internal business rules.
                Control1..1
                This element is affected by the following invariants: au-core-prac-01
                TypeHumanName
                Is Modifierfalse
                Must Supporttrue
                Summarytrue
                Requirements

                The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                au-core-prac-01: At least text or family name shall be present (text.exists() or family.exists())
                40. PractitionerRole.contained:practitioner.name.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
                42. PractitionerRole.contained:practitioner.name.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())
                SlicingThis element introduces a set of slices on PractitionerRole.contained.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 44. PractitionerRole.contained:practitioner.name.use
                  Definition

                  Identifies the purpose for this name.

                  Shortusual | official | temp | nickname | anonymous | old | maiden
                  Comments

                  Applications can assume that a name is current unless it explicitly says that it is temporary or old.

                  Control0..1
                  BindingThe codes SHALL be taken from NameUse
                  (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

                  The use of a human name.

                  Typecode
                  Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  Allows the appropriate name for a particular context of use to be selected from among a set of names.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  46. PractitionerRole.contained:practitioner.name.text
                  Definition

                  Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

                  ShortText representation of the full name
                  Comments

                  Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

                  Control0..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  A renderable, unencoded form.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  48. PractitionerRole.contained:practitioner.name.family
                  Definition

                  The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

                  ShortFamily name (often called 'Surname')
                  Comments

                  Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

                  Control1..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Alternate Namessurname
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  50. PractitionerRole.contained:practitioner.name.given
                  Definition

                  Given name.

                  ShortGiven names (not always 'first'). Includes middle names
                  Comments

                  If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

                  Control1..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Alternate Namesfirst name, middle name
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  52. PractitionerRole.contained:practitioner.name.prefix
                  Definition

                  Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

                  ShortParts that come before the name
                  Control0..*
                  Typestring
                  Is Modifierfalse
                  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()))
                  54. PractitionerRole.contained:practitioner.name.suffix
                  Definition

                  Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

                  ShortParts that come after the name
                  Control0..*
                  Typestring
                  Is Modifierfalse
                  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()))
                  56. PractitionerRole.contained:practitioner.name.period
                  Definition

                  Indicates the period of time when this name was valid for the named person.

                  ShortTime period when name was/is in use
                  Control0..1
                  TypePeriod
                  Is Modifierfalse
                  Summarytrue
                  Requirements

                  Allows names to be placed in historical context.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  58. PractitionerRole.contained:practitioner.telecom
                  Definition

                  A contact detail for the practitioner, e.g. a telephone number or an email address.

                  ShortA contact detail for the practitioner (that apply to all roles)
                  Comments

                  Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.

                  Control0..*
                  TypeContactPoint
                  Is Modifierfalse
                  Must Supporttrue
                  Summarytrue
                  Requirements

                  Need to know how to reach a practitioner independent to any roles the practitioner may have.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  60. PractitionerRole.contained:practitioner.address
                  Definition

                  An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.

                  ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
                  Comments

                  The address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

                  Control0..*
                  This element is affected by the following invariants: ele-1
                  TypeAddress(Address, Australian Address)
                  Is Modifierfalse
                  Must Supporttrue
                  Must Support TypesNo must-support rules about the choice of types/profiles
                  Requirements

                  The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  62. PractitionerRole.contained:practitioner.gender
                  Definition

                  Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

                  Shortmale | female | other | unknown
                  Control0..1
                  BindingThe codes SHALL be taken from AdministrativeGender
                  (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

                  The gender of a person used for administrative purposes.

                  Typecode
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  Needed to address the person correctly.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  64. PractitionerRole.contained:practitioner.birthDate
                  Definition

                  The date of birth for the practitioner.

                  ShortThe date on which the practitioner was born
                  Control0..1
                  Typedate
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  Needed for identification.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  66. PractitionerRole.contained:practitioner.photo
                  Definition

                  Image of the person.

                  ShortImage of the person
                  Control0..*
                  TypeAttachment
                  Is Modifierfalse
                  Summaryfalse
                  Requirements

                  Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  68. PractitionerRole.contained:practitioner.qualification
                  Definition

                  The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.

                  ShortCertification, licenses, or training pertaining to the provision of care
                  Control0..*
                  TypeBackboneElement
                  Is Modifierfalse
                  Must Supporttrue
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  inv-pra-0: A qualification shall only have Ahpra Profession details if the code is Ahpra Profession (extension('http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details').exists() implies code.coding.where(system='http://terminology.hl7.org.au/CodeSystem/v2-0360' and code='AUAHPRAProfession').exists())
                  inv-pra-1: A qualification shall only have Ahpra Registration details if the code is Ahpra Registration (extension('http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details').exists() implies code.coding.where(system='http://terminology.hl7.org.au/CodeSystem/v2-0360' and code='AUAHPRARegistration').exists())
                  70. PractitionerRole.contained:practitioner.qualification.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
                  72. PractitionerRole.contained:practitioner.qualification.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.contained.qualification.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 74. PractitionerRole.contained:practitioner.qualification.extension:ahpraProfession-details
                    Slice NameahpraProfession-details
                    Definition

                    An Extension

                    ShortAhpra Profession Details
                    Control0..1
                    This element is affected by the following invariants: ele-1, inv-pra-0
                    TypeExtension(Ahpra Profession Details) (Complex Extension)
                    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())
                    76. PractitionerRole.contained:practitioner.qualification.extension:ahpraRegistration-details
                    Slice NameahpraRegistration-details
                    Definition

                    Details on the Ahpra registration of profession.

                    ShortAhpra Registration Details
                    Control0..1
                    This element is affected by the following invariants: ele-1, inv-pat-1
                    TypeExtension(Ahpra Registration Details) (Complex Extension)
                    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())
                    78. PractitionerRole.contained:practitioner.qualification.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.contained:practitioner.qualification.identifier
                    Definition

                    An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

                    ShortAn identifier intended for computation
                    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 Ahpra Registration Number)
                    Is Modifierfalse
                    Must Supporttrue
                    Must Support TypesNo must-support rules about the choice of types/profiles
                    Requirements

                    Often, specific identities are assigned for the qualification.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    82. PractitionerRole.contained:practitioner.qualification.code
                    Definition

                    Coded representation of the qualification.

                    ShortCoded representation of the qualification
                    Control1..1
                    This element is affected by the following invariants: inv-pra-0, inv-pat-1
                    BindingThe codes SHOULD be taken from hl7VS-degreeLicenseCertificate - AU Extended
                    (preferred to http://terminology.hl7.org.au/ValueSet/v2-0360-extended)
                    TypeCodeableConcept
                    Is Modifierfalse
                    Must Supporttrue
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    84. PractitionerRole.contained:practitioner.qualification.period
                    Definition

                    Period during which the qualification is valid.

                    ShortPeriod during which the qualification is valid
                    Control0..1
                    TypePeriod
                    Is Modifierfalse
                    Must Supporttrue
                    Summaryfalse
                    Requirements

                    Qualifications are often for a limited period of time, and can be revoked.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    86. PractitionerRole.contained:practitioner.qualification.issuer
                    Definition

                    Organization that regulates and issues the qualification.

                    ShortOrganization that regulates and issues the qualification
                    Control0..1
                    TypeReference(Organization)
                    Is Modifierfalse
                    Must Supporttrue
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    88. PractitionerRole.contained:practitioner.communication
                    Definition

                    A language the practitioner can use in patient communication.

                    ShortA language the practitioner can use in patient communication
                    Comments

                    The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

                    Control0..*
                    BindingUnless not suitable, these codes SHALL be taken from Common Languages in Australia .
                    (extensible to https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2)
                    TypeCodeableConcept
                    Is Modifierfalse
                    Must Supporttrue
                    Summaryfalse
                    Requirements

                    Knowing which language a practitioner speaks can help in facilitating communication with patients.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    90. PractitionerRole.contained:organization
                    Slice Nameorganization
                    Definition

                    A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

                    ShortAn organisation in an Australian healthcare context
                    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..1
                    TypeOrganization(AU Core Organization)
                    Is Modifierfalse
                    Must Supporttrue
                    Summaryfalse
                    92. PractitionerRole.contained:organization.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
                    94. PractitionerRole.contained:organization.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()))
                    96. PractitionerRole.contained:organization.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()))
                    98. PractitionerRole.contained:organization.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()))
                    100. PractitionerRole.contained:organization.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()))
                    102. PractitionerRole.contained:organization.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
                    104. PractitionerRole.contained:organization.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())
                    106. PractitionerRole.contained:organization.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())
                    108. PractitionerRole.contained:organization.identifier
                    Definition

                    Identifier for the organization that is used to identify the organization across multiple disparate systems.

                    ShortIdentifies this organization across multiple systems
                    NoteThis is a business identifier, not a resource identifier (see discussion)
                    Control0..*
                    This element is affected by the following invariants: ele-1, au-core-org-01
                    TypeIdentifier(Identifier, AU HPI-O, AU PAI-O Identifier, AU CSP Registration Number, AU Australian Business Number, AU Australian Company Number, AU Australian Registered Body Number, AU NATA Accreditation Number, AU Pharmacy Approval Number)
                    Is Modifierfalse
                    Must Supporttrue
                    Must Support TypesNo must-support rules about the choice of types/profiles
                    Requirements

                    Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    au-core-org-01: A National Organisation Identifier (type=NOI) shall be an HPI-O or PAI-O (where(type.coding.code = 'NOI').exists() implies (system='http://ns.electronichealth.net.au/id/hi/hpio/1.0') or (system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0'))
                    SlicingThis element introduces a set of slices on PractitionerRole.contained.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • pattern @ system
                    • 110. PractitionerRole.contained:organization.identifier:hpio
                      Slice Namehpio
                      Definition

                      Healthcare Provider Identifier – Organisation (HPI-O) assigned under the HI Service to an organisation (such as a hospital or medical clinic) where healthcare is provided.

                      ShortHealthcare Provider Identifier – Organisation (HPI-O)
                      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 HPI-O)
                      Is Modifierfalse
                      Must Supporttrue
                      Requirements

                      Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      inv-hpio-0: HPI-O shall be 16 digits (value.matches('^([0-9]{16})$'))
                      inv-hpio-1: HPI-O prefix shall be 800362 (value.startsWith('800362'))
                      inv-hpio-2: HPI-O shall pass the Luhn algorithm check ((((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0))
                      112. PractitionerRole.contained:organization.identifier:abn
                      Slice Nameabn
                      Definition

                      Australian Business Number (ABN) assigned by the Australian Securities and Investment Commission (ASIC) to an entity registered in the Australian Business Register (ABR).

                      ShortAustralian Business Number (ABN)
                      NoteThis is a business identifier, not a resource identifier (see discussion)
                      Control0..*
                      This element is affected by the following invariants: ele-1
                      TypeIdentifier(AU Australian Business Number)
                      Is Modifierfalse
                      Must Supporttrue
                      Requirements

                      Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      inv-abn-0: ABN shall be 11 digits (value.matches('^([0-9]{11})$'))
                      114. PractitionerRole.contained:organization.active
                      Definition

                      Whether the organization's record is still in active use.

                      ShortWhether the organization's record is still in active use
                      Comments

                      This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.

                      This element is labeled as a modifier because it may be used to mark that the resource was created in error.

                      Control0..1
                      Typeboolean
                      Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

                      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()))
                      116. PractitionerRole.contained:organization.type
                      Definition

                      The kind(s) of organization that this is.

                      ShortKind of organization
                      Comments

                      When selecting a code for Organization type, if a system is unable to provide a code from the preferred value set Healthcare Organisation Role Type because the implementation context is not restricted to healthcare practitioner providers then it is recommended to select from the wider set available in SNOMED CT. If a suitable code from SNOMED CT is not available, a code from the code system Australian and New Zealand Standard Industrial Classification (ANZSIC), 2006 (Revision 2.0) may be used.

                      Control0..*
                      BindingThe codes SHOULD be taken from Healthcare Organisation Role Type .
                      (preferred to https://healthterminologies.gov.au/fhir/ValueSet/healthcare-organisation-role-type-1)
                      TypeCodeableConcept
                      Is Modifierfalse
                      Must Supporttrue
                      Summarytrue
                      Requirements

                      Need to be able to track the kind of organization that this is - different organization types have different uses.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      118. PractitionerRole.contained:organization.name
                      Definition

                      A name associated with the organization.

                      ShortRequester site name
                      Comments

                      If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.

                      Control1..1
                      This element is affected by the following invariants: org-1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supporttrue
                      Summarytrue
                      Requirements

                      Need to use the name as the label of the organization.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      120. PractitionerRole.contained:organization.alias
                      Definition

                      A list of alternate names that the organization is known as, or was known as in the past.

                      ShortA list of alternate names that the organization is known as, or was known as in the past
                      Comments

                      There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.

                      Control0..*
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supporttrue
                      Summaryfalse
                      Requirements

                      Over time locations and organizations go through many changes and can be known by different names.

                      For searching knowing previous names that the organization was known by can be very useful.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      122. PractitionerRole.contained:organization.telecom
                      Definition

                      A contact detail for the organization.

                      ShortA contact detail for the organization
                      Comments

                      The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

                      Control0..*
                      This element is affected by the following invariants: org-3
                      TypeContactPoint
                      Is Modifierfalse
                      Must Supporttrue
                      Summaryfalse
                      Requirements

                      Human contact for the organization.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
                      124. PractitionerRole.contained:organization.address
                      Definition

                      An address for the organization.

                      ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
                      Comments

                      The address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

                      Control0..*
                      This element is affected by the following invariants: ele-1
                      TypeAddress(Address, Australian Address)
                      Is Modifierfalse
                      Must Supporttrue
                      Must Support TypesNo must-support rules about the choice of types/profiles
                      Requirements

                      May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())
                      126. PractitionerRole.contained:organization.partOf
                      Definition

                      The organization of which this organization forms a part.

                      ShortThe organization of which this organization forms a part
                      Control0..1
                      TypeReference(Organization)
                      Is Modifierfalse
                      Summarytrue
                      Requirements

                      Need to be able to track the hierarchy of organizations within an organization.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      128. PractitionerRole.contained:organization.contact
                      Definition

                      Contact for the organization for a certain purpose.

                      ShortContact for the organization for a certain purpose
                      Comments

                      Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.

                      Control0..*
                      TypeBackboneElement
                      Is Modifierfalse
                      Summaryfalse
                      Requirements

                      Need to keep track of assigned contact points within bigger organization.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      130. PractitionerRole.contained:organization.contact.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
                      132. PractitionerRole.contained:organization.contact.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())
                      134. PractitionerRole.contained:organization.contact.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())
                      136. PractitionerRole.contained:organization.contact.purpose
                      Definition

                      Indicates a purpose for which the contact can be reached.

                      ShortThe type of contact
                      Control0..1
                      BindingUnless not suitable, these codes SHALL be taken from Contact Purpose
                      (extensible to http://terminology.hl7.org.au/ValueSet/contact-purpose)
                      TypeCodeableConcept
                      Is Modifierfalse
                      Summaryfalse
                      Requirements

                      Need to distinguish between multiple contact persons.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      138. PractitionerRole.contained:organization.contact.name
                      Definition

                      A name associated with the contact.

                      ShortA name associated with the contact
                      Control0..1
                      TypeHumanName
                      Is Modifierfalse
                      Summaryfalse
                      Requirements

                      Need to be able to track the person by name.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      140. PractitionerRole.contained:organization.contact.telecom
                      Definition

                      A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.

                      ShortContact details (telephone, email, etc.) for a contact
                      Control0..*
                      TypeContactPoint
                      Is Modifierfalse
                      Summaryfalse
                      Requirements

                      People have (primary) ways to contact them in some way such as phone, email.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      142. PractitionerRole.contained:organization.contact.address
                      Definition

                      Visiting or postal addresses for the contact.

                      ShortVisiting or postal addresses for the contact
                      Control0..1
                      TypeAddress
                      Is Modifierfalse
                      Summaryfalse
                      Requirements

                      May need to keep track of a contact party's address for contacting, billing or reporting requirements.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      144. PractitionerRole.contained:organization.endpoint
                      Definition

                      Technical endpoints providing access to services operated for the organization.

                      ShortTechnical endpoints providing access to services operated for the organization
                      Control0..*
                      TypeReference(Endpoint)
                      Is Modifierfalse
                      Summaryfalse
                      Requirements

                      Organizations have multiple systems that provide various services and 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()))
                      146. 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())
                      148. 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())
                      150. 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
                      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
                      • 152. 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
                        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()))
                        154. PractitionerRole.identifier:employeeNumber
                        Slice NameemployeeNumber
                        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..1
                        This element is affected by the following invariants: ele-1
                        TypeIdentifier(AU Employee Number)
                        Is Modifierfalse
                        Must Supporttrue
                        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()))
                        156. 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()))
                        158. 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()))
                        160. 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 Core Practitioner)
                        Is Modifierfalse
                        Must Supporttrue
                        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 (reference.exists() or identifier.exists() or display.exists())
                        162. PractitionerRole.practitioner.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
                        164. PractitionerRole.practitioner.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())
                        SlicingThis element introduces a set of slices on PractitionerRole.practitioner.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 166. PractitionerRole.practitioner.reference
                          Definition

                          A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                          ShortReference to contained Practitioner resource
                          Comments

                          Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                          Control1..1
                          This element is affected by the following invariants: ref-1
                          Typestring
                          Is Modifierfalse
                          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()))
                          168. PractitionerRole.practitioner.type
                          Definition

                          The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                          The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                          ShortType the reference refers to (e.g. "Patient")
                          Comments

                          This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                          Control0..1
                          BindingUnless not suitable, these codes SHALL be taken from ResourceType
                          (extensible to http://hl7.org/fhir/ValueSet/resource-types)

                          Aa resource (or, for logical models, the URI of the logical model).

                          Typeuri
                          Is Modifierfalse
                          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()))
                          170. PractitionerRole.practitioner.identifier
                          Definition

                          An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                          ShortLogical reference, when literal reference is not known
                          Comments

                          When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                          When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                          Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                          Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                          NoteThis is a business identifier, not a resource identifier (see discussion)
                          Control0..1
                          TypeIdentifier
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          172. PractitionerRole.practitioner.display
                          Definition

                          Plain text narrative that identifies the resource in addition to the resource reference.

                          ShortText alternative for the resource
                          Comments

                          This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                          Control0..1
                          Typestring
                          Is Modifierfalse
                          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()))
                          174. PractitionerRole.organization
                          Definition

                          The organization where the Practitioner performs the roles associated.

                          ShortOrganization where the roles are available
                          Control0..1
                          TypeReference(AU Core Organization)
                          Is Modifierfalse
                          Must Supporttrue
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          176. PractitionerRole.organization.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
                          178. PractitionerRole.organization.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())
                          SlicingThis element introduces a set of slices on PractitionerRole.organization.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 180. PractitionerRole.organization.reference
                            Definition

                            A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                            ShortReference to contained Organization resource
                            Comments

                            Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                            Control1..1
                            This element is affected by the following invariants: ref-1
                            Typestring
                            Is Modifierfalse
                            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()))
                            182. PractitionerRole.organization.type
                            Definition

                            The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                            The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                            ShortType the reference refers to (e.g. "Patient")
                            Comments

                            This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                            Control0..1
                            BindingUnless not suitable, these codes SHALL be taken from ResourceType
                            (extensible to http://hl7.org/fhir/ValueSet/resource-types)

                            Aa resource (or, for logical models, the URI of the logical model).

                            Typeuri
                            Is Modifierfalse
                            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()))
                            184. PractitionerRole.organization.identifier
                            Definition

                            An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                            ShortLogical reference, when literal reference is not known
                            Comments

                            When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                            When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                            Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                            Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                            NoteThis is a business identifier, not a resource identifier (see discussion)
                            Control0..1
                            TypeIdentifier
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            186. PractitionerRole.organization.display
                            Definition

                            Plain text narrative that identifies the resource in addition to the resource reference.

                            ShortText alternative for the resource
                            Comments

                            This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                            Control0..1
                            Typestring
                            Is Modifierfalse
                            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()))
                            188. 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
                            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()))
                            190. 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
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            192. PractitionerRole.location
                            Definition

                            The location(s) at which this practitioner provides care.

                            ShortThe location(s) at which this practitioner provides care
                            Control0..*
                            TypeReference(AU Core Location)
                            Is Modifierfalse
                            Must Supporttrue
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            194. 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()))
                            196. 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
                            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()))
                            198. 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()))
                            200. 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
                            202. 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())
                            204. 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())
                            206. 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()))
                            208. 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()))
                            210. 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()))
                            212. 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
                            214. 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
                            • 216. 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())
                              218. 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
                              220. 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()))
                              222. 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
                              224. 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
                              • 226. 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())
                                228. 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
                                230. 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()))
                                232. 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
                                234. 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())
                                236. 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())
                                238. 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()))
                                240. 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()))
                                242. 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()))
                                244. 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()))