AU Base Implementation Guide
4.2.0-preview - Working Australia flag

This page is part of the Australian Base IG (v4.2.0-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 4.1.0. For a full list of available versions, see the Directory of published versions

Extension: Ahpra Registration Details

Official URL: http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details Version: 4.2.0-preview
Standards status: Trial-use Maturity Level: 1 Computable Name: AhpraRegistrationDetails

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This extension applies to the Practitioner.qualification element and is used to represent Australian Health Practitioner Regulation Agency (Ahpra) registration details (see Ahpra for further information). This extension supports the inclusion of the Ahpra profession code and information about division, speciality, registration status, endorsements and notations in a qualification element instance representing a practitioner’s Ahpra registration.

This extension may be used on the following element(s):

  • Element ID Practitioner.qualification

Usage Notes

Profile specific implementation guidance:

  • See Ahpra Data Guidance for detailed guidance on representing Ahpra data using this extension.

Usage:

Formal Views of Extension Content

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

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionAhpra Registration Details
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:ahpraProfession 0..*ExtensionAhpra registered profession
.... url 1..1uri"ahpraProfession"
.... value[x] 0..1CodeableConceptAhpra registered profession type code
... extension:ahpraRegistrationRecordNumber 0..*ExtensionAhpra registration number details
.... url 1..1uri"ahpraRegistrationRecordNumber"
.... value[x] 0..1stringAhpra registration number value
.... url 1..1uri"ahpraDivision"
.... value[x] 0..1CodeableConceptAhpra registration division value
... extension:ahpraRegistrationType 0..*ExtensionAhpra registration type details
.... url 1..1uri"ahpraRegistrationType"
.... value[x] 0..1CodeableConceptAhpra registration type value
... extension:ahpraRegistrationSubtype 0..*ExtensionAhpra registration subtype details
.... url 1..1uri"ahpraRegistrationSubtype"
.... value[x] 0..1CodeableConceptAhpra registration subtype value
... extension:ahpraRegistrationStatus 0..*ExtensionAhpra registration status details
.... url 1..1uri"ahpraRegistrationStatus"
.... value[x] 0..1CodeableConceptAhpra registration status value
... extension:ahpraSpecialty 0..*ExtensionAhpra registration specialty details
.... url 1..1uri"ahpraSpecialty"
.... value[x] 0..1CodeableConceptAhpra registration specialty value
... extension:ahpraFieldofSpecialtyPractice 0..*ExtensionAhpra registered field of specialty practice details
.... url 1..1uri"ahpraFieldofSpecialtyPractice"
.... value[x] 0..1CodeableConceptAhpra registered field of specialty practice value
... extension:ahpraEndorsement 0..*ExtensionAhpra registered endorsement details
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:ahpraEndorsementEditDate 0..1ExtensionAhpra registered endorsement edited date details
..... url 1..1uri"ahpraEndorsementEditDate"
..... value[x] 0..1dateAhpra registered endorsement edited date value
.... extension:ahpraEndorsementType 0..1ExtensionAhpra registered endorsement type details
..... url 1..1uri"ahpraEndorsementType"
..... value[x] 0..1CodeableConceptAhpra registered endorsement type value
.... extension:ahpraEndorsementSubtype 0..1ExtensionAhpra registered endorsement subtype details
..... url 1..1uri"ahpraEndorsementSubtype"
..... value[x] 0..1CodeableConceptAhpra registered endorsement subtype value
.... extension:ahpraEndorsementDetail 0..1ExtensionAhpra registered endorsement descriptive details
..... url 1..1uri"ahpraEndorsementDetail"
..... value[x] 0..1stringAhpra registered endorsement descriptive details value
.... url 1..1uri"ahpraEndorsement"
.... value[x] 0..0
... extension:ahpraNotation 0..*ExtensionAhpra other notation details
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:ahpraNotationEditDate 0..1ExtensionAhpra notation edit date details
..... url 1..1uri"ahpraNotationEditDate"
..... value[x] 0..1dateAhpra notation edit date value
.... extension:ahpraNotationType 0..1ExtensionAhpra notation type details
..... url 1..1uri"ahpraNotationType"
..... value[x] 0..1CodeableConceptAhpra notation type value
.... extension:ahpraNotationDetail 0..1ExtensionAhpra notation descriptive details
..... url 1..1uri"ahpraNotationDetail"
..... value[x] 0..1stringAhpra notation descriptive details value
.... url 1..1uri"ahpraNotation"
.... value[x] 0..0
... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionAhpra Registration Details
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:ahpraProfession 0..*ExtensionAhpra registered profession
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ahpraProfession"
.... value[x] 0..1CodeableConceptAhpra registered profession type code
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ahpraRegistrationRecordNumber"
.... value[x] 0..1stringAhpra registration number value
... extension:ahpraDivision 0..*ExtensionAhpra registration division details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ahpraDivision"
.... value[x] 0..1CodeableConceptAhpra registration division value
... extension:ahpraRegistrationType 0..*ExtensionAhpra registration type details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ahpraRegistrationType"
.... value[x] 0..1CodeableConceptAhpra registration type value
... extension:ahpraRegistrationSubtype 0..*ExtensionAhpra registration subtype details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ahpraRegistrationSubtype"
.... value[x] 0..1CodeableConceptAhpra registration subtype value
... extension:ahpraRegistrationStatus 0..*ExtensionAhpra registration status details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ahpraRegistrationStatus"
.... value[x] 0..1CodeableConceptAhpra registration status value
... extension:ahpraSpecialty 0..*ExtensionAhpra registration specialty details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ahpraSpecialty"
.... value[x] 0..1CodeableConceptAhpra registration specialty value
... extension:ahpraFieldofSpecialtyPractice 0..*ExtensionAhpra registered field of specialty practice details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ahpraFieldofSpecialtyPractice"
.... value[x] 0..1CodeableConceptAhpra registered field of specialty practice value
... extension:ahpraEndorsement 0..*ExtensionAhpra registered endorsement details
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:ahpraEndorsementEditDate 0..1ExtensionAhpra registered endorsement edited date details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"ahpraEndorsementEditDate"
..... value[x] 0..1dateAhpra registered endorsement edited date value
.... extension:ahpraEndorsementType 0..1ExtensionAhpra registered endorsement type details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"ahpraEndorsementType"
..... value[x] 0..1CodeableConceptAhpra registered endorsement type value
.... extension:ahpraEndorsementSubtype 0..1ExtensionAhpra registered endorsement subtype details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"ahpraEndorsementSubtype"
..... value[x] 0..1CodeableConceptAhpra registered endorsement subtype value
.... extension:ahpraEndorsementDetail 0..1ExtensionAhpra registered endorsement descriptive details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"ahpraEndorsementDetail"
..... value[x] 0..1stringAhpra registered endorsement descriptive details value
.... url 1..1uri"ahpraEndorsement"
... extension:ahpraNotation 0..*ExtensionAhpra other notation details
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:ahpraNotationEditDate 0..1ExtensionAhpra notation edit date details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"ahpraNotationEditDate"
..... value[x] 0..1dateAhpra notation edit date value
.... extension:ahpraNotationType 0..1ExtensionAhpra notation type details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"ahpraNotationType"
..... value[x] 0..1CodeableConceptAhpra notation type value
.... extension:ahpraNotationDetail 0..1ExtensionAhpra notation descriptive details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"ahpraNotationDetail"
..... value[x] 0..1stringAhpra notation descriptive details value
.... url 1..1uri"ahpraNotation"
... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: This extension applies to the Practitioner.qualification element and is used to represent Australian Health Practitioner Regulation Agency (Ahpra) registration details (see Ahpra for further information). This extension supports the inclusion of the Ahpra profession code and information about division, speciality, registration status, endorsements and notations in a qualification element instance representing a practitioner’s Ahpra registration.

  • ahpraProfession: CodeableConcept: Details on the Ahpra profession registration.
  • ahpraRegistrationRecordNumber: string: Ahpra registration number details.
  • ahpraDivision: CodeableConcept: Ahpra registration division details.
  • ahpraRegistrationType: CodeableConcept: Ahpra registration type details.
  • ahpraRegistrationSubtype: CodeableConcept: Ahpra registration subtype details.
  • ahpraRegistrationStatus: CodeableConcept: Ahpra registration status details.
  • ahpraSpecialty: CodeableConcept: Ahpra registration specialty details.
  • ahpraFieldofSpecialtyPractice: CodeableConcept: Ahpra registered field of specialty practice details.
  • ahpraEndorsementEditDate: date: Ahpra registered endorsement last edited date details.
  • ahpraEndorsementType: CodeableConcept: Ahpra registered endorsement type details.
  • ahpraEndorsementSubtype: CodeableConcept: Ahpra registered endorsement subtype details.
  • ahpraEndorsementDetail: string: Ahpra registered endorsement descriptive details.
  • ahpraNotationEditDate: date: Ahpra notation last edit date details.
  • ahpraNotationType: CodeableConcept: Ahpra notation type details.
  • ahpraNotationDetail: string: Ahpra notation descriptive details.

Maturity: 1

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionAhpra Registration Details
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:ahpraProfession 0..*ExtensionAhpra registered profession
.... url 1..1uri"ahpraProfession"
.... value[x] 0..1CodeableConceptAhpra registered profession type code
... extension:ahpraRegistrationRecordNumber 0..*ExtensionAhpra registration number details
.... url 1..1uri"ahpraRegistrationRecordNumber"
.... value[x] 0..1stringAhpra registration number value
.... url 1..1uri"ahpraDivision"
.... value[x] 0..1CodeableConceptAhpra registration division value
... extension:ahpraRegistrationType 0..*ExtensionAhpra registration type details
.... url 1..1uri"ahpraRegistrationType"
.... value[x] 0..1CodeableConceptAhpra registration type value
... extension:ahpraRegistrationSubtype 0..*ExtensionAhpra registration subtype details
.... url 1..1uri"ahpraRegistrationSubtype"
.... value[x] 0..1CodeableConceptAhpra registration subtype value
... extension:ahpraRegistrationStatus 0..*ExtensionAhpra registration status details
.... url 1..1uri"ahpraRegistrationStatus"
.... value[x] 0..1CodeableConceptAhpra registration status value
... extension:ahpraSpecialty 0..*ExtensionAhpra registration specialty details
.... url 1..1uri"ahpraSpecialty"
.... value[x] 0..1CodeableConceptAhpra registration specialty value
... extension:ahpraFieldofSpecialtyPractice 0..*ExtensionAhpra registered field of specialty practice details
.... url 1..1uri"ahpraFieldofSpecialtyPractice"
.... value[x] 0..1CodeableConceptAhpra registered field of specialty practice value
... extension:ahpraEndorsement 0..*ExtensionAhpra registered endorsement details
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:ahpraEndorsementEditDate 0..1ExtensionAhpra registered endorsement edited date details
..... url 1..1uri"ahpraEndorsementEditDate"
..... value[x] 0..1dateAhpra registered endorsement edited date value
.... extension:ahpraEndorsementType 0..1ExtensionAhpra registered endorsement type details
..... url 1..1uri"ahpraEndorsementType"
..... value[x] 0..1CodeableConceptAhpra registered endorsement type value
.... extension:ahpraEndorsementSubtype 0..1ExtensionAhpra registered endorsement subtype details
..... url 1..1uri"ahpraEndorsementSubtype"
..... value[x] 0..1CodeableConceptAhpra registered endorsement subtype value
.... extension:ahpraEndorsementDetail 0..1ExtensionAhpra registered endorsement descriptive details
..... url 1..1uri"ahpraEndorsementDetail"
..... value[x] 0..1stringAhpra registered endorsement descriptive details value
.... url 1..1uri"ahpraEndorsement"
.... value[x] 0..0
... extension:ahpraNotation 0..*ExtensionAhpra other notation details
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:ahpraNotationEditDate 0..1ExtensionAhpra notation edit date details
..... url 1..1uri"ahpraNotationEditDate"
..... value[x] 0..1dateAhpra notation edit date value
.... extension:ahpraNotationType 0..1ExtensionAhpra notation type details
..... url 1..1uri"ahpraNotationType"
..... value[x] 0..1CodeableConceptAhpra notation type value
.... extension:ahpraNotationDetail 0..1ExtensionAhpra notation descriptive details
..... url 1..1uri"ahpraNotationDetail"
..... value[x] 0..1stringAhpra notation descriptive details value
.... url 1..1uri"ahpraNotation"
.... value[x] 0..0
... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionAhpra Registration Details
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:ahpraProfession 0..*ExtensionAhpra registered profession
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ahpraProfession"
.... value[x] 0..1CodeableConceptAhpra registered profession type code
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ahpraRegistrationRecordNumber"
.... value[x] 0..1stringAhpra registration number value
... extension:ahpraDivision 0..*ExtensionAhpra registration division details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ahpraDivision"
.... value[x] 0..1CodeableConceptAhpra registration division value
... extension:ahpraRegistrationType 0..*ExtensionAhpra registration type details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ahpraRegistrationType"
.... value[x] 0..1CodeableConceptAhpra registration type value
... extension:ahpraRegistrationSubtype 0..*ExtensionAhpra registration subtype details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ahpraRegistrationSubtype"
.... value[x] 0..1CodeableConceptAhpra registration subtype value
... extension:ahpraRegistrationStatus 0..*ExtensionAhpra registration status details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ahpraRegistrationStatus"
.... value[x] 0..1CodeableConceptAhpra registration status value
... extension:ahpraSpecialty 0..*ExtensionAhpra registration specialty details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ahpraSpecialty"
.... value[x] 0..1CodeableConceptAhpra registration specialty value
... extension:ahpraFieldofSpecialtyPractice 0..*ExtensionAhpra registered field of specialty practice details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ahpraFieldofSpecialtyPractice"
.... value[x] 0..1CodeableConceptAhpra registered field of specialty practice value
... extension:ahpraEndorsement 0..*ExtensionAhpra registered endorsement details
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:ahpraEndorsementEditDate 0..1ExtensionAhpra registered endorsement edited date details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"ahpraEndorsementEditDate"
..... value[x] 0..1dateAhpra registered endorsement edited date value
.... extension:ahpraEndorsementType 0..1ExtensionAhpra registered endorsement type details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"ahpraEndorsementType"
..... value[x] 0..1CodeableConceptAhpra registered endorsement type value
.... extension:ahpraEndorsementSubtype 0..1ExtensionAhpra registered endorsement subtype details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"ahpraEndorsementSubtype"
..... value[x] 0..1CodeableConceptAhpra registered endorsement subtype value
.... extension:ahpraEndorsementDetail 0..1ExtensionAhpra registered endorsement descriptive details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"ahpraEndorsementDetail"
..... value[x] 0..1stringAhpra registered endorsement descriptive details value
.... url 1..1uri"ahpraEndorsement"
... extension:ahpraNotation 0..*ExtensionAhpra other notation details
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:ahpraNotationEditDate 0..1ExtensionAhpra notation edit date details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"ahpraNotationEditDate"
..... value[x] 0..1dateAhpra notation edit date value
.... extension:ahpraNotationType 0..1ExtensionAhpra notation type details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"ahpraNotationType"
..... value[x] 0..1CodeableConceptAhpra notation type value
.... extension:ahpraNotationDetail 0..1ExtensionAhpra notation descriptive details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"ahpraNotationDetail"
..... value[x] 0..1stringAhpra notation descriptive details value
.... url 1..1uri"ahpraNotation"
... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()