AU Base Implementation Guide
4.2.2-ci-build - CI Build Australia flag

AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 4.2.2-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-base/ and changes regularly. See the Directory of published versions

Extension: Ahpra Registration Details

Official URL: http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details Version: 4.2.2-ci-build
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:

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..* Extension Ahpra Registration Details
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ahpraProfession 0..* Extension Ahpra registered profession
..... url 1..1 uri "ahpraProfession"
..... value[x] 0..1 CodeableConcept Ahpra registered profession type code
.... extension:ahpraRegistrationRecordNumber 0..* Extension Ahpra registration number details
..... url 1..1 uri "ahpraRegistrationRecordNumber"
..... value[x] 0..1 string Ahpra registration number value
.... extension:ahpraDivision 0..* Extension Ahpra registration division details
..... url 1..1 uri "ahpraDivision"
..... value[x] 0..1 CodeableConcept Ahpra registration division value
.... extension:ahpraRegistrationType 0..* Extension Ahpra registration type details
..... url 1..1 uri "ahpraRegistrationType"
..... value[x] 0..1 CodeableConcept Ahpra registration type value
.... extension:ahpraRegistrationSubtype 0..* Extension Ahpra registration subtype details
..... url 1..1 uri "ahpraRegistrationSubtype"
..... value[x] 0..1 CodeableConcept Ahpra registration subtype value
.... extension:ahpraRegistrationStatus 0..* Extension Ahpra registration status details
..... url 1..1 uri "ahpraRegistrationStatus"
..... value[x] 0..1 CodeableConcept Ahpra registration status value
.... extension:ahpraSpecialty 0..* Extension Ahpra registration specialty details
..... url 1..1 uri "ahpraSpecialty"
..... value[x] 0..1 CodeableConcept Ahpra registration specialty value
.... extension:ahpraFieldofSpecialtyPractice 0..* Extension Ahpra registered field of specialty practice details
..... url 1..1 uri "ahpraFieldofSpecialtyPractice"
..... value[x] 0..1 CodeableConcept Ahpra registered field of specialty practice value
.... extension:ahpraEndorsement 0..* Extension Ahpra registered endorsement details
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ahpraEndorsementEditDate 0..1 Extension Ahpra registered endorsement edited date details
....... url 1..1 uri "ahpraEndorsementEditDate"
....... value[x] 0..1 date Ahpra registered endorsement edited date value
...... extension:ahpraEndorsementType 0..1 Extension Ahpra registered endorsement type details
....... url 1..1 uri "ahpraEndorsementType"
....... value[x] 0..1 CodeableConcept Ahpra registered endorsement type value
...... extension:ahpraEndorsementSubtype 0..1 Extension Ahpra registered endorsement subtype details
....... url 1..1 uri "ahpraEndorsementSubtype"
....... value[x] 0..1 CodeableConcept Ahpra registered endorsement subtype value
...... extension:ahpraEndorsementDetail 0..1 Extension Ahpra registered endorsement descriptive details
....... url 1..1 uri "ahpraEndorsementDetail"
....... value[x] 0..1 string Ahpra registered endorsement descriptive details value
..... url 1..1 uri "ahpraEndorsement"
..... value[x] 0..0
.... extension:ahpraNotation 0..* Extension Ahpra other notation details
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ahpraNotationEditDate 0..1 Extension Ahpra notation edit date details
....... url 1..1 uri "ahpraNotationEditDate"
....... value[x] 0..1 date Ahpra notation edit date value
...... extension:ahpraNotationType 0..1 Extension Ahpra notation type details
....... url 1..1 uri "ahpraNotationType"
....... value[x] 0..1 CodeableConcept Ahpra notation type value
...... extension:ahpraNotationDetail 0..1 Extension Ahpra notation descriptive details
....... url 1..1 uri "ahpraNotationDetail"
....... value[x] 0..1 string Ahpra notation descriptive details value
..... url 1..1 uri "ahpraNotation"
..... value[x] 0..0
... url 1..1 uri "http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details"
... value[x] 0..0

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

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Ahpra Registration Details
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ahpraProfession 0..* Extension Ahpra registered profession
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "ahpraProfession"
..... value[x] 0..1 CodeableConcept Ahpra registered profession type code
.... extension:ahpraRegistrationRecordNumber 0..* Extension Ahpra registration number details
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "ahpraRegistrationRecordNumber"
..... value[x] 0..1 string Ahpra registration number value
.... extension:ahpraDivision 0..* Extension Ahpra registration division details
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "ahpraDivision"
..... value[x] 0..1 CodeableConcept Ahpra registration division value
.... extension:ahpraRegistrationType 0..* Extension Ahpra registration type details
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "ahpraRegistrationType"
..... value[x] 0..1 CodeableConcept Ahpra registration type value
.... extension:ahpraRegistrationSubtype 0..* Extension Ahpra registration subtype details
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "ahpraRegistrationSubtype"
..... value[x] 0..1 CodeableConcept Ahpra registration subtype value
.... extension:ahpraRegistrationStatus 0..* Extension Ahpra registration status details
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "ahpraRegistrationStatus"
..... value[x] 0..1 CodeableConcept Ahpra registration status value
.... extension:ahpraSpecialty 0..* Extension Ahpra registration specialty details
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "ahpraSpecialty"
..... value[x] 0..1 CodeableConcept Ahpra registration specialty value
.... extension:ahpraFieldofSpecialtyPractice 0..* Extension Ahpra registered field of specialty practice details
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "ahpraFieldofSpecialtyPractice"
..... value[x] 0..1 CodeableConcept Ahpra registered field of specialty practice value
.... extension:ahpraEndorsement 0..* Extension Ahpra registered endorsement details
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ahpraEndorsementEditDate 0..1 Extension Ahpra registered endorsement edited date details
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "ahpraEndorsementEditDate"
....... value[x] 0..1 date Ahpra registered endorsement edited date value
...... extension:ahpraEndorsementType 0..1 Extension Ahpra registered endorsement type details
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "ahpraEndorsementType"
....... value[x] 0..1 CodeableConcept Ahpra registered endorsement type value
...... extension:ahpraEndorsementSubtype 0..1 Extension Ahpra registered endorsement subtype details
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "ahpraEndorsementSubtype"
....... value[x] 0..1 CodeableConcept Ahpra registered endorsement subtype value
...... extension:ahpraEndorsementDetail 0..1 Extension Ahpra registered endorsement descriptive details
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "ahpraEndorsementDetail"
....... value[x] 0..1 string Ahpra registered endorsement descriptive details value
..... url 1..1 uri "ahpraEndorsement"
.... extension:ahpraNotation 0..* Extension Ahpra other notation details
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ahpraNotationEditDate 0..1 Extension Ahpra notation edit date details
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "ahpraNotationEditDate"
....... value[x] 0..1 date Ahpra notation edit date value
...... extension:ahpraNotationType 0..1 Extension Ahpra notation type details
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "ahpraNotationType"
....... value[x] 0..1 CodeableConcept Ahpra notation type value
...... extension:ahpraNotationDetail 0..1 Extension Ahpra notation descriptive details
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "ahpraNotationDetail"
....... value[x] 0..1 string Ahpra notation descriptive details value
..... url 1..1 uri "ahpraNotation"
... url 1..1 uri "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()