AU Patient Summary Implementation Guide
1.0.1-ci-build - CI Build Australia flag

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

Resource Profile: AU PS Practitioner

Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-practitioner Version: 1.0.1-ci-build
Standards status: Trial-use Maturity Level: 2 Computable Name: AUPSPractitioner

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for a Practitioner resource in the context of a patient summary in an Australian context. It is based on the AU Core Practitioner profile, and applies the additional requirements from Practitioner (IPS).

See Comparison With Other National and International IGs for a comparison between AU Patient Summary (AU PS) profiles and profiles in other implementation guides.

Profile Specific Implementation Guidance

  • Even though AU PS Profiles allow both PractitionerRole and Practitioner to be referenced, because PractitionerRole supplies a provider’s location, contact information, and reference to the Practitioner, it SHOULD be referenced instead of the Practitioner resource.
  • See the guidance on implementing the Practitioner resource in AU Core.

Examples for this Profile: Bundle/aups-basicsummary, Bundle/aups-gpvisit-retrieval, Bundle/aups-noknownx, Bundle/aups-referral-endoconsult-autogen and Bundle/aups-referral-endoconsult-curated

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner C 0..* AUCorePractitioner A person with a formal responsibility in the provisioning of services
This profile also complies with the profile Practitioner (IPS)
Constraints: inv-pra-0, inv-pra-1, inv-pra-2, inv-pra-3, inv-pra-4, inv-pra-5
Practitioner.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Practitioner.Slices for extension Content/Rules for all slices
Practitioner.Slices for extension.extension:genderIdentity C 0..* (Complex) Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Practitioner.Slices for extension.extension:individualPronouns 0..* (Complex) Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Practitioner.Slices for extension.extension:recordedSexOrGender C 0..* (Complex) Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply.
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Practitioner.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Practitioner.Slices for identifier This element has obligations and must be supported. This element is included in summaries. 0..* Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUHPII The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUPBSPrescriberNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUCareAgencyEmployeeIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUAhpraRegistrationNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An identifier for the person as this agent
Slice: Unordered, Open by pattern:type
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:hpii This element has obligations and must be supported. This element is included in summaries. 0..1 AUHPII The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An identifier for the person as this agent
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.name This element has obligations and must be supported. This element is included in summaries. 1..* HumanName The name(s) associated with the practitioner
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Practitioner.name.family This element has obligations and must be supported. This element is included in summaries. 1..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.name.given This element has obligations and must be supported. This element is included in summaries. 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.telecom This element has obligations and must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.address This element has obligations and must be supported. This element is included in summaries. 0..* Address The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AustralianAddress The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Address(es) of the practitioner that are not role specific (typically home address)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Practitioner.name.use Base required NameUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Practitioner If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Practitioner If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Practitioner If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Practitioner If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Practitioner A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
inv-pra-0 warning Practitioner Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
inv-pra-1 warning Practitioner Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
inv-pra-2 warning Practitioner Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
inv-pra-3 warning Practitioner Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
inv-pra-4 warning Practitioner Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
inv-pra-5 warning Practitioner Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))

This structure is derived from AUCorePractitioner

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner 0..* AUCorePractitioner A person with a formal responsibility in the provisioning of services
This profile also complies with the profile Practitioner (IPS)
Practitioner.identifier This element has obligations. 0..* Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber An identifier for the person as this agent
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.Slices for identifier Content/Rules for all slices
Practitioner.Slices for identifier.identifier:hpii This element has obligations. 0..1 AUHPII An identifier for the person as this agent
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.name This element has obligations. 1..* HumanName The name(s) associated with the practitioner
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.name.family This element has obligations. 1..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.name.given This element has obligations. 0..* string Given names (not always 'first'). Includes middle names
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.address This element has obligations and must be supported. 0..* Address, AustralianAddress Address(es) of the practitioner that are not role specific (typically home address)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner C 0..* AUCorePractitioner A person with a formal responsibility in the provisioning of services
This profile also complies with the profile Practitioner (IPS)
Constraints: inv-pra-0, inv-pra-1, inv-pra-2, inv-pra-3, inv-pra-4, inv-pra-5
Practitioner.id This element is included in summaries. 0..1 id Logical id of this artifact
Practitioner.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Practitioner.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Practitioner.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Practitioner.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Practitioner.contained 0..* Resource Contained, inline Resources
Practitioner.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:genderIdentity C 0..* (Complex) Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Practitioner.Slices for extension.extension:individualPronouns 0..* (Complex) Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Practitioner.Slices for extension.extension:recordedSexOrGender C 0..* (Complex) Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply.
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Practitioner.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Practitioner.Slices for identifier This element has obligations and must be supported. This element is included in summaries. 0..* Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUHPII The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUPBSPrescriberNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUCareAgencyEmployeeIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUAhpraRegistrationNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An identifier for the person as this agent
Slice: Unordered, Open by pattern:type
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:hpii This element has obligations and must be supported. This element is included in summaries. 0..1 AUHPII The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An identifier for the person as this agent
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.active This element is included in summaries. 0..1 boolean Whether this practitioner's record is in active use
Practitioner.name This element has obligations and must be supported. This element is included in summaries. 1..* HumanName The name(s) associated with the practitioner
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.name.id 0..1 string Unique id for inter-element referencing
Practitioner.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Practitioner.name.text This element is included in summaries. 0..1 string Text representation of the full name
Practitioner.name.family This element has obligations and must be supported. This element is included in summaries. 1..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.name.given This element has obligations and must be supported. This element is included in summaries. 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Practitioner.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Practitioner.name.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Practitioner.telecom This element has obligations and must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.address This element has obligations and must be supported. This element is included in summaries. 0..* Address The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AustralianAddress The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Address(es) of the practitioner that are not role specific (typically home address)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Practitioner.birthDate This element is included in summaries. 0..1 date The date on which the practitioner was born
Practitioner.photo 0..* Attachment Image of the person
Practitioner.qualification 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
Practitioner.qualification.id 0..1 string Unique id for inter-element referencing
Practitioner.qualification.extension 0..* Extension Additional content defined by implementations
Practitioner.qualification.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Practitioner.qualification.identifier 0..* Identifier An identifier for this qualification for the practitioner
Practitioner.qualification.code 1..1 CodeableConcept Coded representation of the qualification
Binding: hl7VS-degreeLicenseCertificate - AU Extended (preferred)
Practitioner.qualification.period 0..1 Period Period during which the qualification is valid
Practitioner.qualification.issuer 0..1 Reference(Organization) Organization that regulates and issues the qualification
Practitioner.communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: Common Languages in Australia (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Practitioner.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Practitioner.name.use Base required NameUse 📍4.0.1 FHIR Std.
Practitioner.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Practitioner.qualification.​code Base preferred hl7VS-degreeLicenseCertificate - AU Extended 📦7.0.0-ci-build AU Base Implementation Guide vnull
Practitioner.communication Base extensible Common Languages in Australia ⏿2.2.1 tx.hl7.org.au

Constraints

Id Grade Path(s) Description Expression
dom-2 error Practitioner If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Practitioner If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Practitioner If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Practitioner If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Practitioner A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
inv-pra-0 warning Practitioner Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
inv-pra-1 warning Practitioner Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
inv-pra-2 warning Practitioner Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
inv-pra-3 warning Practitioner Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
inv-pra-4 warning Practitioner Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
inv-pra-5 warning Practitioner Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))

This structure is derived from AUCorePractitioner

Summary

Must-Support: 2 elements

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner C 0..* AUCorePractitioner A person with a formal responsibility in the provisioning of services
This profile also complies with the profile Practitioner (IPS)
Constraints: inv-pra-0, inv-pra-1, inv-pra-2, inv-pra-3, inv-pra-4, inv-pra-5
Practitioner.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Practitioner.Slices for extension Content/Rules for all slices
Practitioner.Slices for extension.extension:genderIdentity C 0..* (Complex) Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Practitioner.Slices for extension.extension:individualPronouns 0..* (Complex) Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Practitioner.Slices for extension.extension:recordedSexOrGender C 0..* (Complex) Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply.
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Practitioner.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Practitioner.Slices for identifier This element has obligations and must be supported. This element is included in summaries. 0..* Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUHPII The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUPBSPrescriberNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUCareAgencyEmployeeIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUAhpraRegistrationNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An identifier for the person as this agent
Slice: Unordered, Open by pattern:type
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:hpii This element has obligations and must be supported. This element is included in summaries. 0..1 AUHPII The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An identifier for the person as this agent
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.name This element has obligations and must be supported. This element is included in summaries. 1..* HumanName The name(s) associated with the practitioner
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Practitioner.name.family This element has obligations and must be supported. This element is included in summaries. 1..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.name.given This element has obligations and must be supported. This element is included in summaries. 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.telecom This element has obligations and must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.address This element has obligations and must be supported. This element is included in summaries. 0..* Address The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AustralianAddress The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Address(es) of the practitioner that are not role specific (typically home address)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Practitioner.name.use Base required NameUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Practitioner If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Practitioner If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Practitioner If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Practitioner If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Practitioner A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
inv-pra-0 warning Practitioner Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
inv-pra-1 warning Practitioner Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
inv-pra-2 warning Practitioner Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
inv-pra-3 warning Practitioner Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
inv-pra-4 warning Practitioner Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
inv-pra-5 warning Practitioner Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))

Differential View

This structure is derived from AUCorePractitioner

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner 0..* AUCorePractitioner A person with a formal responsibility in the provisioning of services
This profile also complies with the profile Practitioner (IPS)
Practitioner.identifier This element has obligations. 0..* Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber An identifier for the person as this agent
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.Slices for identifier Content/Rules for all slices
Practitioner.Slices for identifier.identifier:hpii This element has obligations. 0..1 AUHPII An identifier for the person as this agent
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.name This element has obligations. 1..* HumanName The name(s) associated with the practitioner
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.name.family This element has obligations. 1..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.name.given This element has obligations. 0..* string Given names (not always 'first'). Includes middle names
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.telecom This element has obligations and must be supported. 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.address This element has obligations and must be supported. 0..* Address, AustralianAddress Address(es) of the practitioner that are not role specific (typically home address)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner C 0..* AUCorePractitioner A person with a formal responsibility in the provisioning of services
This profile also complies with the profile Practitioner (IPS)
Constraints: inv-pra-0, inv-pra-1, inv-pra-2, inv-pra-3, inv-pra-4, inv-pra-5
Practitioner.id This element is included in summaries. 0..1 id Logical id of this artifact
Practitioner.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Practitioner.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Practitioner.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Practitioner.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Practitioner.contained 0..* Resource Contained, inline Resources
Practitioner.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:genderIdentity C 0..* (Complex) Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Practitioner.Slices for extension.extension:individualPronouns 0..* (Complex) Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Practitioner.Slices for extension.extension:recordedSexOrGender C 0..* (Complex) Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply.
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Practitioner.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Practitioner.Slices for identifier This element has obligations and must be supported. This element is included in summaries. 0..* Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUHPII The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUPBSPrescriberNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUCareAgencyEmployeeIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUAhpraRegistrationNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An identifier for the person as this agent
Slice: Unordered, Open by pattern:type
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:hpii This element has obligations and must be supported. This element is included in summaries. 0..1 AUHPII The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An identifier for the person as this agent
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.active This element is included in summaries. 0..1 boolean Whether this practitioner's record is in active use
Practitioner.name This element has obligations and must be supported. This element is included in summaries. 1..* HumanName The name(s) associated with the practitioner
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.name.id 0..1 string Unique id for inter-element referencing
Practitioner.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Practitioner.name.text This element is included in summaries. 0..1 string Text representation of the full name
Practitioner.name.family This element has obligations and must be supported. This element is included in summaries. 1..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.name.given This element has obligations and must be supported. This element is included in summaries. 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Practitioner.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Practitioner.name.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Practitioner.telecom This element has obligations and must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.address This element has obligations and must be supported. This element is included in summaries. 0..* Address The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AustralianAddress The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Address(es) of the practitioner that are not role specific (typically home address)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Practitioner.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Practitioner.birthDate This element is included in summaries. 0..1 date The date on which the practitioner was born
Practitioner.photo 0..* Attachment Image of the person
Practitioner.qualification 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
Practitioner.qualification.id 0..1 string Unique id for inter-element referencing
Practitioner.qualification.extension 0..* Extension Additional content defined by implementations
Practitioner.qualification.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Practitioner.qualification.identifier 0..* Identifier An identifier for this qualification for the practitioner
Practitioner.qualification.code 1..1 CodeableConcept Coded representation of the qualification
Binding: hl7VS-degreeLicenseCertificate - AU Extended (preferred)
Practitioner.qualification.period 0..1 Period Period during which the qualification is valid
Practitioner.qualification.issuer 0..1 Reference(Organization) Organization that regulates and issues the qualification
Practitioner.communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: Common Languages in Australia (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Practitioner.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Practitioner.name.use Base required NameUse 📍4.0.1 FHIR Std.
Practitioner.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Practitioner.qualification.​code Base preferred hl7VS-degreeLicenseCertificate - AU Extended 📦7.0.0-ci-build AU Base Implementation Guide vnull
Practitioner.communication Base extensible Common Languages in Australia ⏿2.2.1 tx.hl7.org.au

Constraints

Id Grade Path(s) Description Expression
dom-2 error Practitioner If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Practitioner If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Practitioner If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Practitioner If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Practitioner A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
inv-pra-0 warning Practitioner Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
inv-pra-1 warning Practitioner Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
inv-pra-2 warning Practitioner Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
inv-pra-3 warning Practitioner Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
inv-pra-4 warning Practitioner Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
inv-pra-5 warning Practitioner Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))

This structure is derived from AUCorePractitioner

Summary

Must-Support: 2 elements

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron