Australian Base Implementation Guide (AU Base 2)

AU Base Implementation Guide, published by HL7 Australia. This is not an authorized publication; it is the continuous build for version 2.0.0). 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

1.0 StructureDefinition-au-practitioner

AU Base Practitioner Profile [FMM Level 3]

This profile defines a practitioner administration details structure that includes core localisation concepts for use in an Australian context.

Identifiers

These definitions represent common data held in the Practitioner.identifier element:

  • Healthcare Provider Identifier - Individual - HPI-I [1]
  • Medicare Prescriber Number [1]
  • Care Agency Employee (CAE) Identifier [1]
  • Australian Health Practitioner Regulation Agency (AHPRA) Registration Number [1] [2]

Qualifications

These definitions represent common data held in the Practitioner.qualification element:

  • Australian Health Practitioner Regulation Agency (AHPRA) Registration Number [1] [2]

Usage Notes

Where a sending system includes a practitioner’s qualification using their AHPRA Registration Number, this should be done using Practitioner.qualification(ahpraRegistration). A practitioner’s AHPRA Registration Number may also be included as an identifier, using Practitioner.identifier(ahpraRegistration).

Examples

Practitioner with HPI-I, Prescriber Number and AHPRA Registration Number

Qualified Radiologist

Qualified Pathologist

AHPRA qualified General Practitioner

1.0.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org.au/fhir/StructureDefinition/au-practitioner

This profile defines a practitioner administration details structure that includes core localisation concepts for use in an Australian context.

This profile builds on Practitioner.

This profile was published on Fri Jul 26 00:00:00 UTC 2019 as a draft by Health Level Seven Australia (Patient Administration WG).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*A practitioner in an Australian healthcare context
... identifier 0..*(Slice Definition)Slice: Unordered, Open by pattern:type, value:system
.... identifier:hpii I0..1IdentifierHealthcare Provider Identifier – Individual (HPI-I)
inv-hpii-0: HPI-I shall be 16 digits
inv-hpii-1: HPI-I prefix shall be 800361
inv-hpii-2: HPI-I shall pass the Luhn algorithm check
..... type 0..1CodeableConceptCoded identifier type for HPI-I
Binding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
...... text 0..1stringFixed Value: HPI-I
..... system 1..1uriNamespace for HPI-I
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpii/1.0
..... value 1..1stringHPI-I number
Example HPI-I number: 8003619900015717
Max Length: 16
.... identifier:medicarePrescriberNumber 0..*IdentifierMedicare Prescriber Number
..... type 0..1CodeableConceptCoded identifier type for prescriber number
Binding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRES
...... text 0..1stringFixed Value: Prescriber Number
..... system 1..1uriNamespace for prescriber number
Fixed Value: http://ns.electronichealth.net.au/id/medicare-prescriber-number
..... value 1..1stringMedicare Prescriber number
Example prescriber number: 453221
.... identifier:careAgencyEmployeeIdentifier I0..*IdentifierCare Agency Employee (CAE) Identifier
inv-caei-0: CAE identifier shall be 16 digits
inv-caei-1: CAE identifier prefix shall be 900360
inv-caei-2: CAE identifier shall pass the Luhn algorithm check
..... type 0..1CodeableConceptIdentifier type for CAE identifier
Binding: V2 Identifier Type - AU Extended (required)
...... text 0..1stringFixed Value: Care Agency Employee Identifier
..... system 1..1uriNamespace for CAE identifier
Fixed Value: http://ns.electronichealth.net.au/id/pcehr/caei/1.0
..... value 1..1stringCAE identifier number
.... identifier:ahpraRegistration I0..*IdentifierAustralian Health Practitioner Regulation Agency (AHPRA) registration as identifier
inv-ahpra-0: AHPRA identifier shall be 3 uppercase letters, followed by 10 digits
..... type 1..1CodeableConceptBinding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: AHPRA
...... text 1..1stringFixed Value: AHPRA Registration Number
..... system 1..1uriFixed Value: http://hl7.org.au/id/ahpra-registration-number
..... value 1..1stringExample AHPRA registration number: ANZ1234567890
... qualification 0..*(Slice Definition)Slice: Unordered, Open by value:identifier.system
.... qualification:ahpraRegistration 0..*BackboneElementAustralian Health Practitioner Regulation Agency (AHPRA) qualification details
..... identifier I1..1IdentifierAHPRA Registration Number
inv-ahpra-1: AHPRA registration value shall be 3 uppercase letters, followed by 10 digits
...... type 1..1CodeableConceptCoded identifier type for AHPRA registration number
Binding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: AHPRA
....... text 1..1stringFixed Value: AHPRA Registration Number
...... system 1..1uriNamespace for AHPRA registration number
Fixed Value: http://hl7.org.au/id/ahpra-registration-number
...... value 1..1stringAHPRA registration number
Example AHPRA registration number: ANZ1234567890
..... code 1..1CodeableConceptAHPRA codings
...... text 1..1stringAHPRA Registration Role
..... issuer 1..1Reference(Organization)
...... display 1..1stringFixed Value: AHPRA
... communication 0..*CodeableConceptBinding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*A practitioner in an Australian healthcare context
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*(Slice Definition)An identifier for the person as this agent
Slice: Unordered, Open by pattern:type, value:system
.... identifier:hpii ΣI0..1IdentifierHealthcare Provider Identifier – Individual (HPI-I)
inv-hpii-0: HPI-I shall be 16 digits
inv-hpii-1: HPI-I prefix shall be 800361
inv-hpii-2: HPI-I shall pass the Luhn algorithm check
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptCoded identifier type for HPI-I
Binding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI0..*CodingCode defined by a terminology system
...... text ΣI0..1stringPlain text representation of the concept
Fixed Value: HPI-I
..... system ΣI1..1uriNamespace for HPI-I
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpii/1.0
..... value ΣI1..1stringHPI-I number
Example General: 123456
Example HPI-I number: 8003619900015717
Max Length: 16
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:medicarePrescriberNumber ΣI0..*IdentifierMedicare Prescriber Number
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptCoded identifier type for prescriber number
Binding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRES
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI0..*CodingCode defined by a terminology system
...... text ΣI0..1stringPlain text representation of the concept
Fixed Value: Prescriber Number
..... system ΣI1..1uriNamespace for prescriber number
Fixed Value: http://ns.electronichealth.net.au/id/medicare-prescriber-number
..... value ΣI1..1stringMedicare Prescriber number
Example General: 123456
Example prescriber number: 453221
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:careAgencyEmployeeIdentifier ΣI0..*IdentifierCare Agency Employee (CAE) Identifier
inv-caei-0: CAE identifier shall be 16 digits
inv-caei-1: CAE identifier prefix shall be 900360
inv-caei-2: CAE identifier shall pass the Luhn algorithm check
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptIdentifier type for CAE identifier
Binding: V2 Identifier Type - AU Extended (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI0..*CodingCode defined by a terminology system
...... text ΣI0..1stringPlain text representation of the concept
Fixed Value: Care Agency Employee Identifier
..... system ΣI1..1uriNamespace for CAE identifier
Fixed Value: http://ns.electronichealth.net.au/id/pcehr/caei/1.0
..... value ΣI1..1stringCAE identifier number
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:ahpraRegistration ΣI0..*IdentifierAustralian Health Practitioner Regulation Agency (AHPRA) registration as identifier
inv-ahpra-0: AHPRA identifier shall be 3 uppercase letters, followed by 10 digits
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI1..1CodeableConceptDescription of identifier
Binding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: AHPRA
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI0..*CodingCode defined by a terminology system
...... text ΣI1..1stringPlain text representation of the concept
Fixed Value: AHPRA Registration Number
..... system ΣI1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.au/id/ahpra-registration-number
..... value ΣI1..1stringThe value that is unique
Example General: 123456
Example AHPRA registration number: ANZ1234567890
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... active ΣI0..1booleanWhether this practitioner's record is in active use
... name ΣI0..*HumanNameThe name(s) associated with the practitioner
... telecom ΣI0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address ΣI0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
... gender ΣI0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ΣI0..1dateThe date on which the practitioner was born
... photo I0..*AttachmentImage of the person
... qualification I0..*(Slice Definition)Certification, licenses, or training pertaining to the provision of care
Slice: Unordered, Open by value:identifier.system
.... qualification:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... identifier I0..*IdentifierAn identifier for this qualification for the practitioner
..... code I1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example)
..... period I0..1PeriodPeriod during which the qualification is valid
..... issuer I0..1Reference(Organization)Organization that regulates and issues the qualification
.... qualification:ahpraRegistration I0..*BackboneElementAustralian Health Practitioner Regulation Agency (AHPRA) qualification details
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... identifier I1..1IdentifierAHPRA Registration Number
inv-ahpra-1: AHPRA registration value shall be 3 uppercase letters, followed by 10 digits
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
...... type ΣI1..1CodeableConceptCoded identifier type for AHPRA registration number
Binding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: AHPRA
........ display0..1stringRepresentation defined by the system
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... coding ΣI0..*CodingCode defined by a terminology system
....... text ΣI1..1stringPlain text representation of the concept
Fixed Value: AHPRA Registration Number
...... system ΣI1..1uriNamespace for AHPRA registration number
Fixed Value: http://hl7.org.au/id/ahpra-registration-number
...... value ΣI1..1stringAHPRA registration number
Example General: 123456
Example AHPRA registration number: ANZ1234567890
...... period ΣI0..1PeriodTime period when id is/was valid for use
...... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
..... code I1..1CodeableConceptAHPRA codings
Binding: v2 table 0360, Version 2.7 (example)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI0..*CodingCode defined by a terminology system
...... text ΣI1..1stringAHPRA Registration Role
..... period I0..1PeriodPeriod during which the qualification is valid
..... issuer I1..1Reference(Organization)Organization that regulates and issues the qualification
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
...... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
...... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
...... display ΣI1..1stringText alternative for the resource
Fixed Value: AHPRA
... communication I0..*CodeableConceptA language the practitioner can use in patient communication
Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*A practitioner in an Australian healthcare context
... identifier 0..*(Slice Definition)Slice: Unordered, Open by pattern:type, value:system
.... identifier:hpii I0..1IdentifierHealthcare Provider Identifier – Individual (HPI-I)
inv-hpii-0: HPI-I shall be 16 digits
inv-hpii-1: HPI-I prefix shall be 800361
inv-hpii-2: HPI-I shall pass the Luhn algorithm check
..... type 0..1CodeableConceptCoded identifier type for HPI-I
Binding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
...... text 0..1stringFixed Value: HPI-I
..... system 1..1uriNamespace for HPI-I
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpii/1.0
..... value 1..1stringHPI-I number
Example HPI-I number: 8003619900015717
Max Length: 16
.... identifier:medicarePrescriberNumber 0..*IdentifierMedicare Prescriber Number
..... type 0..1CodeableConceptCoded identifier type for prescriber number
Binding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRES
...... text 0..1stringFixed Value: Prescriber Number
..... system 1..1uriNamespace for prescriber number
Fixed Value: http://ns.electronichealth.net.au/id/medicare-prescriber-number
..... value 1..1stringMedicare Prescriber number
Example prescriber number: 453221
.... identifier:careAgencyEmployeeIdentifier I0..*IdentifierCare Agency Employee (CAE) Identifier
inv-caei-0: CAE identifier shall be 16 digits
inv-caei-1: CAE identifier prefix shall be 900360
inv-caei-2: CAE identifier shall pass the Luhn algorithm check
..... type 0..1CodeableConceptIdentifier type for CAE identifier
Binding: V2 Identifier Type - AU Extended (required)
...... text 0..1stringFixed Value: Care Agency Employee Identifier
..... system 1..1uriNamespace for CAE identifier
Fixed Value: http://ns.electronichealth.net.au/id/pcehr/caei/1.0
..... value 1..1stringCAE identifier number
.... identifier:ahpraRegistration I0..*IdentifierAustralian Health Practitioner Regulation Agency (AHPRA) registration as identifier
inv-ahpra-0: AHPRA identifier shall be 3 uppercase letters, followed by 10 digits
..... type 1..1CodeableConceptBinding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: AHPRA
...... text 1..1stringFixed Value: AHPRA Registration Number
..... system 1..1uriFixed Value: http://hl7.org.au/id/ahpra-registration-number
..... value 1..1stringExample AHPRA registration number: ANZ1234567890
... qualification 0..*(Slice Definition)Slice: Unordered, Open by value:identifier.system
.... qualification:ahpraRegistration 0..*BackboneElementAustralian Health Practitioner Regulation Agency (AHPRA) qualification details
..... identifier I1..1IdentifierAHPRA Registration Number
inv-ahpra-1: AHPRA registration value shall be 3 uppercase letters, followed by 10 digits
...... type 1..1CodeableConceptCoded identifier type for AHPRA registration number
Binding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: AHPRA
....... text 1..1stringFixed Value: AHPRA Registration Number
...... system 1..1uriNamespace for AHPRA registration number
Fixed Value: http://hl7.org.au/id/ahpra-registration-number
...... value 1..1stringAHPRA registration number
Example AHPRA registration number: ANZ1234567890
..... code 1..1CodeableConceptAHPRA codings
...... text 1..1stringAHPRA Registration Role
..... issuer 1..1Reference(Organization)
...... display 1..1stringFixed Value: AHPRA
... communication 0..*CodeableConceptBinding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*A practitioner in an Australian healthcare context
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*(Slice Definition)An identifier for the person as this agent
Slice: Unordered, Open by pattern:type, value:system
.... identifier:hpii ΣI0..1IdentifierHealthcare Provider Identifier – Individual (HPI-I)
inv-hpii-0: HPI-I shall be 16 digits
inv-hpii-1: HPI-I prefix shall be 800361
inv-hpii-2: HPI-I shall pass the Luhn algorithm check
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptCoded identifier type for HPI-I
Binding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI0..*CodingCode defined by a terminology system
...... text ΣI0..1stringPlain text representation of the concept
Fixed Value: HPI-I
..... system ΣI1..1uriNamespace for HPI-I
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpii/1.0
..... value ΣI1..1stringHPI-I number
Example General: 123456
Example HPI-I number: 8003619900015717
Max Length: 16
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:medicarePrescriberNumber ΣI0..*IdentifierMedicare Prescriber Number
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptCoded identifier type for prescriber number
Binding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRES
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI0..*CodingCode defined by a terminology system
...... text ΣI0..1stringPlain text representation of the concept
Fixed Value: Prescriber Number
..... system ΣI1..1uriNamespace for prescriber number
Fixed Value: http://ns.electronichealth.net.au/id/medicare-prescriber-number
..... value ΣI1..1stringMedicare Prescriber number
Example General: 123456
Example prescriber number: 453221
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:careAgencyEmployeeIdentifier ΣI0..*IdentifierCare Agency Employee (CAE) Identifier
inv-caei-0: CAE identifier shall be 16 digits
inv-caei-1: CAE identifier prefix shall be 900360
inv-caei-2: CAE identifier shall pass the Luhn algorithm check
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptIdentifier type for CAE identifier
Binding: V2 Identifier Type - AU Extended (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI0..*CodingCode defined by a terminology system
...... text ΣI0..1stringPlain text representation of the concept
Fixed Value: Care Agency Employee Identifier
..... system ΣI1..1uriNamespace for CAE identifier
Fixed Value: http://ns.electronichealth.net.au/id/pcehr/caei/1.0
..... value ΣI1..1stringCAE identifier number
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:ahpraRegistration ΣI0..*IdentifierAustralian Health Practitioner Regulation Agency (AHPRA) registration as identifier
inv-ahpra-0: AHPRA identifier shall be 3 uppercase letters, followed by 10 digits
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI1..1CodeableConceptDescription of identifier
Binding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: AHPRA
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI0..*CodingCode defined by a terminology system
...... text ΣI1..1stringPlain text representation of the concept
Fixed Value: AHPRA Registration Number
..... system ΣI1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.au/id/ahpra-registration-number
..... value ΣI1..1stringThe value that is unique
Example General: 123456
Example AHPRA registration number: ANZ1234567890
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... active ΣI0..1booleanWhether this practitioner's record is in active use
... name ΣI0..*HumanNameThe name(s) associated with the practitioner
... telecom ΣI0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address ΣI0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
... gender ΣI0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ΣI0..1dateThe date on which the practitioner was born
... photo I0..*AttachmentImage of the person
... qualification I0..*(Slice Definition)Certification, licenses, or training pertaining to the provision of care
Slice: Unordered, Open by value:identifier.system
.... qualification:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... identifier I0..*IdentifierAn identifier for this qualification for the practitioner
..... code I1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example)
..... period I0..1PeriodPeriod during which the qualification is valid
..... issuer I0..1Reference(Organization)Organization that regulates and issues the qualification
.... qualification:ahpraRegistration I0..*BackboneElementAustralian Health Practitioner Regulation Agency (AHPRA) qualification details
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... identifier I1..1IdentifierAHPRA Registration Number
inv-ahpra-1: AHPRA registration value shall be 3 uppercase letters, followed by 10 digits
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
...... type ΣI1..1CodeableConceptCoded identifier type for AHPRA registration number
Binding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: AHPRA
........ display0..1stringRepresentation defined by the system
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
....... id 0..1stringUnique id for inter-element referencing
....... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... coding ΣI0..*CodingCode defined by a terminology system
....... text ΣI1..1stringPlain text representation of the concept
Fixed Value: AHPRA Registration Number
...... system ΣI1..1uriNamespace for AHPRA registration number
Fixed Value: http://hl7.org.au/id/ahpra-registration-number
...... value ΣI1..1stringAHPRA registration number
Example General: 123456
Example AHPRA registration number: ANZ1234567890
...... period ΣI0..1PeriodTime period when id is/was valid for use
...... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
..... code I1..1CodeableConceptAHPRA codings
Binding: v2 table 0360, Version 2.7 (example)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI0..*CodingCode defined by a terminology system
...... text ΣI1..1stringAHPRA Registration Role
..... period I0..1PeriodPeriod during which the qualification is valid
..... issuer I1..1Reference(Organization)Organization that regulates and issues the qualification
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
...... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
...... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
...... display ΣI1..1stringText alternative for the resource
Fixed Value: AHPRA
... communication I0..*CodeableConceptA language the practitioner can use in patient communication
Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-practitioner

none defined