Australian Provider Directory Implementation Guide (PD 2)

This page is part of the Australian Provider Directory IG (v2.0.1: PD 2 on FHIR R4) based on FHIR R4. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

SD.2 StructureDefinition-au-pd-practitionerrole

Australian Practitioner Role Directory Entry Profile

This profile describes a practitioner in role for an organisation at a location.

The Australian profile for practitioner role is for a single location only, this allows as single provider number to be associated with the role.

In the context of provider directories the practitioner role may include references to endpoints that describe channels of communication to the provider in this role.

Examples

Practitioner Role Directory Entry Example

SD.2.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org.au/fhir/pd/StructureDefinition/au-pd-practitionerrole

Provider directory entry for a practitioner role

This profile builds on AUBasePractitionerRole.

This profile was published on Tue May 14 00:00:00 AEST 2019 as a draft by null.

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

Australian Practitioner Role Directory Entry

  1. Must Support Optional: Meta-Source (uri)
  2. Must Support 0 or more: Medicare Provider Number (Identifier)
    • Must Support Optional Extension: Optional HL7 V2 routing content (Complex)
  3. Must Support 0 or more: Directroy Entry Practitioner at Organisation (Identifier)
    • Must Support Optional Extension: Optional HL7 V2 routing content (Complex)
  4. Must Support 0 or more: Secure Messaging Vendor’s Provider Identifier (Identifier)
    • Must Support Optional Extension: Optional HL7 V2 routing content (Complex)
  5. Must Support Required: Active Status (boolean)
  6. Must Support Required: Practitioner (Reference)
  7. Must Support Required: Organisation (Reference)
  8. Must Support 0 or more: Role Codes (Coding)
  9. Must Support 0 or more: Specialties (Coding)
  10. Must Support 1 or more: Location (Reference)
  11. Must Support 0 or more: HealthcareService (Reference)
  12. Must Support 0 or more: Contact Details - phone, fax, email etc. (ContactPoint)
  13. Must Support 0 or more: Endpoint, secure messaging or others (Reference)
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*
... meta 0..1MetaMetadata on Practitoner Role
.... source S0..1uri
... identifier S(Slice Definition)Slice: Unordered, Open by pattern:type, value:system
.... medicareProviderNumber S0..*IdentifierMedicare Provider Number for Directory Entry Practitioner Role
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... au-assigningauthority S0..1(Complex)HL7 V2 Assigning Authority
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
.... nationalProviderAtOrganisation S0..*IdentifierNational Provider at Organisation Identifier for Directory Entry Practitioner Role
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... au-assigningauthority S0..1(Complex)HL7 V2 Assigning Authority
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
.... vendorAssignedDirectoryIdentifier S0..*IdentifierSecure Messaging Vendor's Provider Identifier
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... au-assigningauthority S0..1(Complex)HL7 V2 Assigning Authority
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
..... type 0..1CodeableConceptVendor assigned directory identifier type
...... coding 1..*CodingVendor assigned directory identifier type code
....... system 0..1uriVendor assigned directory identifier type coding system
....... code 0..1codeFixed Value: VDI
...... text 1..1stringFixed Value: Secure Messaging Vendor Identifier Directory Entry
..... system 0..1uriRequired vendor assigned identifier system URI
..... assigner 1..1Reference(Organization)Assigning vendor reference
...... display 1..1stringAssigning vendor name
... active S1..1booleanRequired status
... practitioner S1..1Reference(AU PD Practitioner)Practitioner in the role
... organization S1..1Reference(AU PD Organisation)Organisation providing this role
... code S0..*CodeableConceptDirectory SNOMED-CT Practitioner Role Code
... specialty S0..*CodeableConceptDirectory SNOMED-CT Practitioner Specialty
... location S1..*Reference(AU PD Location)Location at which this role is provided
... healthcareService S0..*Reference(HealthcareService)Healthcare services provided in this role
... telecom S0..*ContactPointContact details for the practitioner in this role.
... endpoint S0..*Reference(AU PD Secure Messaging Endpoint), Reference(Endpoint)Technical endpoints for this practitioner role, including secure messaging endpoints

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*A practitioner in a healthcare role in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata on Practitoner Role
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source SΣ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example)
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ(Slice Definition)Practitioner role identifiers
Slice: Unordered, Open by pattern:type, value:system
.... medicareProviderNumber SΣ0..*IdentifierMedicare Provider Number for Directory Entry Practitioner Role
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... au-assigningauthority S0..1(Complex)HL7 V2 Assigning Authority
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... namespace-id 0..1ExtensionApplication Identifier
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"namespace-id"
....... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
........ valueString 0..1stringValue of extension
...... universal-id 0..1ExtensionUniversal Identifier Value
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"universal-id"
....... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
........ valueString 0..1stringValue of extension
...... universal-id-type 0..1ExtensionType Scheme of universal-id
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"universal-id-type"
....... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
........ valueString 0..1stringValue of extension
...... url 1..1stringidentifies the meaning of the extension
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type Σ1..1CodeableConceptCoded identifier type for provider 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: UPIN
....... 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 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
...... text Σ0..1stringPlain text representation of the concept
Fixed Value: Medicare Provider Number
..... system Σ1..1uriNamespace for Medicare provider number
Fixed Value: http://ns.electronichealth.net.au/id/medicare-provider-number
..... value Σ1..1stringMedicare provider number
Example General': 123456
Example Medicare provider number': 2426621B
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... nationalProviderAtOrganisation SΣ0..*IdentifierNational Provider at Organisation Identifier for Directory Entry Practitioner Role
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... au-assigningauthority S0..1(Complex)HL7 V2 Assigning Authority
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... namespace-id 0..1ExtensionApplication Identifier
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"namespace-id"
....... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
........ valueString 0..1stringValue of extension
...... universal-id 0..1ExtensionUniversal Identifier Value
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"universal-id"
....... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
........ valueString 0..1stringValue of extension
...... universal-id-type 0..1ExtensionType Scheme of universal-id
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"universal-id-type"
....... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
........ valueString 0..1stringValue of extension
...... url 1..1stringidentifies the meaning of the extension
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type Σ1..1CodeableConceptCoded identifier type for national provider identifier at organisation
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: NPIO
....... 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 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
...... text Σ0..1stringPlain text representation of the concept
Fixed Value: NPIO
..... system Σ1..1uriNamespace for national provider identifier (HPI-I) at organisation with national identifier (HPI-O)
Fixed Value: http://hl7.org.au/id/npio
..... value ΣI1..1stringNational provider identifier at organisation in the form HPI-I@HPI-O
inv-npio-0: NPIO length is exactly 33 characters
Example General': 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... employeeNumber Σ0..*IdentifierEmployee Number
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type Σ1..1CodeableConceptCoded identifier type for employee 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/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: EI
....... 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 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
...... text Σ1..1stringPlain text representation of the concept
Fixed Value: Employee Number
..... system Σ1..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient
..... value Σ1..1stringEmployee number
Example General': 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ1..1Reference(Organization)Employing organisation
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... display Σ1..1stringEmploying organisation name
.... vendorAssignedDirectoryIdentifier SΣ0..*IdentifierSecure Messaging Vendor's Provider Identifier
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... au-assigningauthority S0..1(Complex)HL7 V2 Assigning Authority
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... namespace-id 0..1ExtensionApplication Identifier
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"namespace-id"
....... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
........ valueString 0..1stringValue of extension
...... universal-id 0..1ExtensionUniversal Identifier Value
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"universal-id"
....... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
........ valueString 0..1stringValue of extension
...... universal-id-type 0..1ExtensionType Scheme of universal-id
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"universal-id-type"
....... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
........ valueString 0..1stringValue of extension
...... url 1..1stringidentifies the meaning of the extension
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type Σ0..1CodeableConceptVendor assigned directory identifier type
Binding: Identifier Type Codes (extensible)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ1..*CodingVendor assigned directory identifier type code
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ0..1uriVendor assigned directory identifier type coding system
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: VDI
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ1..1stringPlain text representation of the concept
Fixed Value: Secure Messaging Vendor Identifier Directory Entry
..... system Σ0..1uriRequired vendor assigned identifier system URI
Example General': http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General': 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ1..1Reference(Organization)Assigning vendor reference
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... display Σ1..1stringAssigning vendor name
... active SΣ1..1booleanRequired status
... period Σ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣ1..1Reference(AU PD Practitioner)Practitioner in the role
... organization SΣ1..1Reference(AU PD Organisation)Organisation providing this role
... code SΣ0..*CodeableConceptDirectory SNOMED-CT Practitioner Role Code
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred)
... specialty SΣ0..*CodeableConceptDirectory SNOMED-CT Practitioner Specialty
Binding: Provider Specialties (SNOMED CT AU) (preferred)
... location SΣ1..*Reference(AU PD Location)Location at which this role is provided
... healthcareService S0..*Reference(HealthcareService)Healthcare services provided in this role
... telecom SΣ0..*ContactPointContact details for the practitioner in this role.
... availableTime I0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable I0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint S0..*Reference(AU PD Secure Messaging Endpoint), Reference(Endpoint)Technical endpoints for this practitioner role, including secure messaging endpoints

doco Documentation for this format

Australian Practitioner Role Directory Entry

  1. Must Support Optional: Meta-Source (uri)
  2. Must Support 0 or more: Medicare Provider Number (Identifier)
    • Must Support Optional Extension: Optional HL7 V2 routing content (Complex)
  3. Must Support 0 or more: Directroy Entry Practitioner at Organisation (Identifier)
    • Must Support Optional Extension: Optional HL7 V2 routing content (Complex)
  4. Must Support 0 or more: Secure Messaging Vendor’s Provider Identifier (Identifier)
    • Must Support Optional Extension: Optional HL7 V2 routing content (Complex)
  5. Must Support Required: Active Status (boolean)
  6. Must Support Required: Practitioner (Reference)
  7. Must Support Required: Organisation (Reference)
  8. Must Support 0 or more: Role Codes (Coding)
  9. Must Support 0 or more: Specialties (Coding)
  10. Must Support 1 or more: Location (Reference)
  11. Must Support 0 or more: HealthcareService (Reference)
  12. Must Support 0 or more: Contact Details - phone, fax, email etc. (ContactPoint)
  13. Must Support 0 or more: Endpoint, secure messaging or others (Reference)

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*
... meta 0..1MetaMetadata on Practitoner Role
.... source S0..1uri
... identifier S(Slice Definition)Slice: Unordered, Open by pattern:type, value:system
.... medicareProviderNumber S0..*IdentifierMedicare Provider Number for Directory Entry Practitioner Role
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... au-assigningauthority S0..1(Complex)HL7 V2 Assigning Authority
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
.... nationalProviderAtOrganisation S0..*IdentifierNational Provider at Organisation Identifier for Directory Entry Practitioner Role
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... au-assigningauthority S0..1(Complex)HL7 V2 Assigning Authority
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
.... vendorAssignedDirectoryIdentifier S0..*IdentifierSecure Messaging Vendor's Provider Identifier
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... au-assigningauthority S0..1(Complex)HL7 V2 Assigning Authority
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
..... type 0..1CodeableConceptVendor assigned directory identifier type
...... coding 1..*CodingVendor assigned directory identifier type code
....... system 0..1uriVendor assigned directory identifier type coding system
....... code 0..1codeFixed Value: VDI
...... text 1..1stringFixed Value: Secure Messaging Vendor Identifier Directory Entry
..... system 0..1uriRequired vendor assigned identifier system URI
..... assigner 1..1Reference(Organization)Assigning vendor reference
...... display 1..1stringAssigning vendor name
... active S1..1booleanRequired status
... practitioner S1..1Reference(AU PD Practitioner)Practitioner in the role
... organization S1..1Reference(AU PD Organisation)Organisation providing this role
... code S0..*CodeableConceptDirectory SNOMED-CT Practitioner Role Code
... specialty S0..*CodeableConceptDirectory SNOMED-CT Practitioner Specialty
... location S1..*Reference(AU PD Location)Location at which this role is provided
... healthcareService S0..*Reference(HealthcareService)Healthcare services provided in this role
... telecom S0..*ContactPointContact details for the practitioner in this role.
... endpoint S0..*Reference(AU PD Secure Messaging Endpoint), Reference(Endpoint)Technical endpoints for this practitioner role, including secure messaging endpoints

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*A practitioner in a healthcare role in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata on Practitoner Role
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source SΣ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example)
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ(Slice Definition)Practitioner role identifiers
Slice: Unordered, Open by pattern:type, value:system
.... medicareProviderNumber SΣ0..*IdentifierMedicare Provider Number for Directory Entry Practitioner Role
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... au-assigningauthority S0..1(Complex)HL7 V2 Assigning Authority
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... namespace-id 0..1ExtensionApplication Identifier
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"namespace-id"
....... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
........ valueString 0..1stringValue of extension
...... universal-id 0..1ExtensionUniversal Identifier Value
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"universal-id"
....... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
........ valueString 0..1stringValue of extension
...... universal-id-type 0..1ExtensionType Scheme of universal-id
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"universal-id-type"
....... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
........ valueString 0..1stringValue of extension
...... url 1..1stringidentifies the meaning of the extension
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type Σ1..1CodeableConceptCoded identifier type for provider 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: UPIN
....... 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 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
...... text Σ0..1stringPlain text representation of the concept
Fixed Value: Medicare Provider Number
..... system Σ1..1uriNamespace for Medicare provider number
Fixed Value: http://ns.electronichealth.net.au/id/medicare-provider-number
..... value Σ1..1stringMedicare provider number
Example General': 123456
Example Medicare provider number': 2426621B
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... nationalProviderAtOrganisation SΣ0..*IdentifierNational Provider at Organisation Identifier for Directory Entry Practitioner Role
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... au-assigningauthority S0..1(Complex)HL7 V2 Assigning Authority
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... namespace-id 0..1ExtensionApplication Identifier
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"namespace-id"
....... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
........ valueString 0..1stringValue of extension
...... universal-id 0..1ExtensionUniversal Identifier Value
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"universal-id"
....... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
........ valueString 0..1stringValue of extension
...... universal-id-type 0..1ExtensionType Scheme of universal-id
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"universal-id-type"
....... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
........ valueString 0..1stringValue of extension
...... url 1..1stringidentifies the meaning of the extension
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type Σ1..1CodeableConceptCoded identifier type for national provider identifier at organisation
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: NPIO
....... 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 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
...... text Σ0..1stringPlain text representation of the concept
Fixed Value: NPIO
..... system Σ1..1uriNamespace for national provider identifier (HPI-I) at organisation with national identifier (HPI-O)
Fixed Value: http://hl7.org.au/id/npio
..... value ΣI1..1stringNational provider identifier at organisation in the form HPI-I@HPI-O
inv-npio-0: NPIO length is exactly 33 characters
Example General': 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... employeeNumber Σ0..*IdentifierEmployee Number
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type Σ1..1CodeableConceptCoded identifier type for employee 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/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: EI
....... 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 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
...... text Σ1..1stringPlain text representation of the concept
Fixed Value: Employee Number
..... system Σ1..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient
..... value Σ1..1stringEmployee number
Example General': 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ1..1Reference(Organization)Employing organisation
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... display Σ1..1stringEmploying organisation name
.... vendorAssignedDirectoryIdentifier SΣ0..*IdentifierSecure Messaging Vendor's Provider Identifier
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... au-assigningauthority S0..1(Complex)HL7 V2 Assigning Authority
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... namespace-id 0..1ExtensionApplication Identifier
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"namespace-id"
....... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
........ valueString 0..1stringValue of extension
...... universal-id 0..1ExtensionUniversal Identifier Value
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"universal-id"
....... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
........ valueString 0..1stringValue of extension
...... universal-id-type 0..1ExtensionType Scheme of universal-id
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"universal-id-type"
....... value[x] (Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
........ valueString 0..1stringValue of extension
...... url 1..1stringidentifies the meaning of the extension
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type Σ0..1CodeableConceptVendor assigned directory identifier type
Binding: Identifier Type Codes (extensible)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ1..*CodingVendor assigned directory identifier type code
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ0..1uriVendor assigned directory identifier type coding system
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: VDI
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ1..1stringPlain text representation of the concept
Fixed Value: Secure Messaging Vendor Identifier Directory Entry
..... system Σ0..1uriRequired vendor assigned identifier system URI
Example General': http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General': 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ1..1Reference(Organization)Assigning vendor reference
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... display Σ1..1stringAssigning vendor name
... active SΣ1..1booleanRequired status
... period Σ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣ1..1Reference(AU PD Practitioner)Practitioner in the role
... organization SΣ1..1Reference(AU PD Organisation)Organisation providing this role
... code SΣ0..*CodeableConceptDirectory SNOMED-CT Practitioner Role Code
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred)
... specialty SΣ0..*CodeableConceptDirectory SNOMED-CT Practitioner Specialty
Binding: Provider Specialties (SNOMED CT AU) (preferred)
... location SΣ1..*Reference(AU PD Location)Location at which this role is provided
... healthcareService S0..*Reference(HealthcareService)Healthcare services provided in this role
... telecom SΣ0..*ContactPointContact details for the practitioner in this role.
... availableTime I0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable I0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint S0..*Reference(AU PD Secure Messaging Endpoint), Reference(Endpoint)Technical endpoints for this practitioner role, including secure messaging endpoints

doco Documentation for this format

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

 

SD.2.2 Quick Start

Below is an overview of the requirements for search and read operations.

Read: PractitionerRole

Read identified practitioner role resource content.

GET [base]/PractitionerRole/[id]

Example: GET [base]/PractitionerRole/1234

Support:

  • MUST support read PractitionerRole

Implementation Notes: [(how to read resource)

Search: Active Status

Search based on active status of the practitioner role record.

GET [base]/PractitionerRole?active=[status]

Example: GET [base]/PractitionerRole?active=true

Support: MUST support search PractitionerRole by active status (true | false).

Implementation Notes: (how to search by token)

Search: Provider Practitioner Name

Chained search (via Practitioner) based on family, given and/or any name. Chained search (via Practitioner) based on family, given and/or any name.

GET [base]/PractitionerRole?practitioner.family=[string]

GET [base]/PractitionerRole?practitioner.family=[string]&practitioner.given=[string]

GET [base]/PractitionerRole?practitioner.name=[string]

Example:

GET [base]/PractitionerRole?practitioner.family=Smith

GET [base]/PractitionerRole?practitioner.family=Smith&practitioner.given=John

GET [base]/PractitionerRole?practitioner.name=Smith

Support:

  • MUST support search by Practitioner family, given and name.
  • MUST support basic param=[string] search which is case and accent-insensitive search; field equals or starts with the string value.

Implementation Notes: (how to search by string)

Search: Provider Role

Search based on role code.

GET [base]/PractitionerRole?code=[system]|[code]

Example: GET [base]/PractitionerRole?code=http://snomed.info/sct|397897005

Support:

  • MUST support search PractitionerRole by code.

Implementation Notes: (how to search by token)

Search: Provider Specialty

Search based on specialty code.

GET [base]/PractitionerRole?specialty=[system]|[code]

Example: GET [base]/PractitionerRole?specialty=http://snomed.info/sct|722165004

Support:

  • MUST support search PractitionerRole by specialty.

Implementation Notes: (how to search by token)

Search: Organisation of Provider HPI-O

Chained search (via Organisation) based on identifier token.

GET [base]/PractitionerRole?organization.identifier=[system]|[value]

Example: GET [base]/PractitionerRole?organization.identifier=http://ns.electronichealth.net.au/id/hi/hpio/1.0|8003627500000328

Support:

  • MUST support search by HPI-O.

Implementation Notes: (how to search by token)

Search: Provider Practitioner HPI-I

Chained search (via Practitioner) based on identifier token.

GET [base]/PractitionerRole?practitioner.identifier=[system]|[value]

Example: GET [base]/PractitionerRole?practitioner.identifier=http://ns.electronichealth.net.au/id/hi/hpii/1.0|8003610833334085

Support:

  • MUST support search PractitionerRole by HPI-I.

Implementation Notes: (how to search by token)

Search: Vendor Directory Identifier

Search based on identifier.

GET [base]/PractitionerRole?identifier=[system]|[value]

Example: GET [base]/PractitionerRole?identifier=http://smvendor.com.au/id/provider-id|4412365432

Support:

  • MUST support search PractitionerRole by vendor directory identifier; [system] url will be defined by vendors. Effectively this is a general search for identifier capability.

Implementation Notes: (how to search by token)

Search: Provider Number

Search based on identifier.

GET [base]/PractitionerRole?identifier=[system]|[value]

Example: GET [base]/PractitionerRole?identifier=http://ns.electronichealth.net.au/id/medicare-provider-number|2426621B

Support:

  • MUST support search PractitionerRole by Provider Number.

Implementation Notes: (how to search by token)

Search: National Provider at Organisation Identifier

Search based on identifier.

GET [base]/PractitionerRole?identifier=[system]|[value]

Example: GET [base]/PractitionerRole?identifier=http://ns.electronichealth.net.au/id/npio|8003610833334085@8003627500000328

Support:

  • MUST support search PractitionerRole by National Provider at Organisation Identifier.

Implementation Notes: (how to search by token)

  • Note NPIO format is [HPI-I]@[HPI-O].

Search: Location Address Parts

Chained search (via Location) based on address parts for postcode, suburb, and state.

GET [base]/PractitionerRole?location.address-postalcode=[postcode]

GET [base]/PractitionerRole?location.address-postalcode=[postcode],[postcode]

GET [base]/PractitionerRole?location.address-postalcode=[postcode],[postcode],[postcode] etc.

GET [base]/PractitionerRole?location.address-city=[suburb]

GET [base]/PractitionerRole?location.address-state=[state]

Example:

GET [base]/PractitionerRole?location.address-postalcode=3101

GET [base]/PractitionerRole?location.address-postalcode=3101,3101

GET [base]/PractitionerRole?location.address-city=Bundaberg

GET [base]/PractitionerRole?location.address-state=VIC

Support:

  • MUST support search PractitionerRole by location address parts address-postalcode, address-city, address-state.
  • MUST support basic param=[string] search which is case and accent-insensitive search; field equals or starts with the string value.

Implementation Notes: (how to search by string)

Search: Location Distance

Chained search (via Location) for a location within a nominated distance.

GET [base]/PractitionerRole?location.near=[latitude]:[longitude]&location.near-distance=[prefix][value]|[units-system]|[units]

Example: GET [base]/PractitionerRole?location.near=-83.694810:42.256500&location.near-distance=le10.0|http://unitsofmeasure.org|km

Support:

  • SHOULD support search PractitionerRole by location within a distance.
  • SHOULD support: [prefix] fixed ‘le’ is less than or equal to distance [value] is a decimal quantity number [units-system] fixed ‘http://unitsofmeasure.org’ identifies standard distance units are used [units] distance units must support ‘km’ or ‘m’

Implementation Notes: (how to search by token) and (how to search by quantity)

Search: Connection Type (Service Interface)

Chaned search (via Endpoint) based on token for a protocol to be used to connnect to the endpoint.

GET [base]/PractitionerRole?endpoint.connection-type=[system]|[code]

Example: GET [base]/PractitionerRole?endpoint.connection-type=http://hl7.org.au/fhir/CodeSystem/smd-interfaces|http://ns.electronichealth.net.au/smd/intf/SealedMessageDelivery/TLS/2010

Support:

  • MUST support search by PractitionerRole by endpoint connection type.

Implementation Notes: (how to search by token)

Search: Payload Type (Service Category)

Chaned search (via Endpoint) based on token for the type of content supported by the endpoint.

GET [base]/PractitionerRole?endpoint.payload-type=[system]|[code]

Example: GET [base]/PractitionerRole?endpoint.payload-type=http://hl7.org.au/fhir/CodeSystem/smd-interfaces|http://ns.hl7.org.au/hl7v2/profiles/HL7AU-OO-REF-SIMPLIFIED-201706

Support:

  • MUST support search PractitionerRole by endpoint payload type.

Implementation Notes: (how to search by token)

Search: Include References

The _include argument allows the automatic inclusion of referenced resources in the response for a search; based on search parameters defined for this resource type1.

Example: GET [base]/PractitionerRole?_include=PractitionerRole:practitioner&_include=PractitionerRole:organization&_include=PractitionerRole:endpoint&_include=PractitionerRole:location

Support:

  • MUST support _include PractitionerRole references practitioner (Practitioner), location (Location), organization (Organization), endpoint (Endpoint), service (HealthcareService).

Search: Combination

  • Searches MUST be able to be perfomed in a single request using logical AND for criteria. e.g specialty cardiologist in post code 4846