AU Patient Summary Implementation Guide
0.5.0-cibuild - CI Build Australia flag

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

Resource Profile: AU PS PractitionerRole

Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-practitionerrole Version: 0.5.0-cibuild
Standards status: Draft Maturity Level: 0 Computable Name: AUPSPractitionerRole

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

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

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

Profile Specific Implementation Guidance

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

This structure is derived from AUCorePractitionerRole

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* AUCorePractitionerRole A person with formal responsibility in a role providing one or more services
This profile also complies with the profile PractitionerRole (IPS)
... identifier O 0..* Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber Business Identifiers that are specific to a role/location
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... Slices for identifier Content/Rules for all slices
.... identifier:medicareProvider O 0..1 AUMedicareProviderNumber Business Identifiers that are specific to a role/location
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... practitioner O 1..1 Reference(AU PS Practitioner) Practitioner that is able to provide the defined services for the organization
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... code O 0..* CodeableConceptIPS Roles which this practitioner may perform
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... specialty O 0..* CodeableConceptIPS Specific specialty of the practitioner
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... telecom O 0..* ContactPoint Contact details that are specific to the role/location/service
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* AUCorePractitionerRole A person with formal responsibility in a role providing one or more services
This profile also complies with the profile PractitionerRole (IPS)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SOΣ 0..* Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber Business Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... identifier:medicareProvider SOΣ 0..1 AUMedicareProviderNumber Business Identifiers that are specific to a role/location
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... organization SOΣ 0..1 Reference(AU PS Organization) Organization where the roles are available
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... code SOΣ 0..* CodeableConceptIPS Roles which this practitioner may perform
Binding: Practitioner Role . (preferred)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... specialty SOΣ 0..* CodeableConceptIPS Specific specialty of the practitioner
Binding: Clinical Specialty . (preferred)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... telecom SOΣ 0..* ContactPoint Contact details that are specific to the role/location/service
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... system SOΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SOΣ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.codepreferredPractitionerRole .
https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
PractitionerRole.specialtypreferredClinicalSpecialty .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1
PractitionerRole.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
PractitionerRole.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
au-core-prarol-01errorPractitionerRole.practitionerAt least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present
: (reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
dom-2errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerRoleIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerRoleA resource should have narrative for robust management
: text.`div`.exists()
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()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* AUCorePractitionerRole A person with formal responsibility in a role providing one or more services
This profile also complies with the profile PractitionerRole (IPS)
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SOΣ 0..* Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber Business Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... identifier:medicareProvider SOΣ 0..1 AUMedicareProviderNumber Business Identifiers that are specific to a role/location
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... active Σ 0..1 boolean Whether this practitioner role record is in active use
... period Σ 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
... practitioner SOΣC 1..1 Reference(AU PS Practitioner) Practitioner that is able to provide the defined services for the organization
Constraints: au-core-prarol-01
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... organization SOΣ 0..1 Reference(AU PS Organization) Organization where the roles are available
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... code SOΣ 0..* CodeableConceptIPS Roles which this practitioner may perform
Binding: Practitioner Role . (preferred)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... specialty SOΣ 0..* CodeableConceptIPS Specific specialty of the practitioner
Binding: Clinical Specialty . (preferred)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... location Σ 0..* Reference(Location) The location(s) at which this practitioner provides care
... healthcareService 0..* Reference(HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SOΣ 0..* ContactPoint Contact details that are specific to the role/location/service
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SOΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SOΣ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... availableTime 0..* BackboneElement Times the Service Site is available
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.
.... allDay 0..1 boolean Always available? e.g. 24 hour service
.... availableStartTime 0..1 time Opening time of day (ignored if allDay = true)
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:timeZone 0..1 code IANA Timezone Code per BCP 175
URL: http://hl7.org/fhir/StructureDefinition/timezone
Binding: IANATimezones (required): IANA Timezones (BCP 175)
..... value 0..1 time Primitive value for time
.... availableEndTime 0..1 time Closing time of day (ignored if allDay = true)
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:timeZone 0..1 code IANA Timezone Code per BCP 175
URL: http://hl7.org/fhir/StructureDefinition/timezone
Binding: IANATimezones (required): IANA Timezones (BCP 175)
..... value 0..1 time Primitive value for time
... notAvailable 0..* BackboneElement Not available during this time due to provided reason
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description 1..1 string Reason presented to the user explaining why time not available
.... during 0..1 Period Service not available from this date
... availabilityExceptions 0..1 string Description of availability exceptions
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
PractitionerRole.codepreferredPractitionerRole .
https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
PractitionerRole.specialtypreferredClinicalSpecialty .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1
PractitionerRole.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
PractitionerRole.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
au-core-prarol-01errorPractitionerRole.practitionerAt least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present
: (reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
dom-2errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerRoleIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerRoleA resource should have narrative for robust management
: text.`div`.exists()
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()

Differential View

This structure is derived from AUCorePractitionerRole

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* AUCorePractitionerRole A person with formal responsibility in a role providing one or more services
This profile also complies with the profile PractitionerRole (IPS)
... identifier O 0..* Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber Business Identifiers that are specific to a role/location
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... Slices for identifier Content/Rules for all slices
.... identifier:medicareProvider O 0..1 AUMedicareProviderNumber Business Identifiers that are specific to a role/location
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... practitioner O 1..1 Reference(AU PS Practitioner) Practitioner that is able to provide the defined services for the organization
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... code O 0..* CodeableConceptIPS Roles which this practitioner may perform
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... specialty O 0..* CodeableConceptIPS Specific specialty of the practitioner
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... telecom O 0..* ContactPoint Contact details that are specific to the role/location/service
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* AUCorePractitionerRole A person with formal responsibility in a role providing one or more services
This profile also complies with the profile PractitionerRole (IPS)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SOΣ 0..* Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber Business Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... identifier:medicareProvider SOΣ 0..1 AUMedicareProviderNumber Business Identifiers that are specific to a role/location
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... organization SOΣ 0..1 Reference(AU PS Organization) Organization where the roles are available
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... code SOΣ 0..* CodeableConceptIPS Roles which this practitioner may perform
Binding: Practitioner Role . (preferred)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... specialty SOΣ 0..* CodeableConceptIPS Specific specialty of the practitioner
Binding: Clinical Specialty . (preferred)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... telecom SOΣ 0..* ContactPoint Contact details that are specific to the role/location/service
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... system SOΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SOΣ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.codepreferredPractitionerRole .
https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
PractitionerRole.specialtypreferredClinicalSpecialty .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1
PractitionerRole.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
PractitionerRole.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
au-core-prarol-01errorPractitionerRole.practitionerAt least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present
: (reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
dom-2errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerRoleIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerRoleA resource should have narrative for robust management
: text.`div`.exists()
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()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* AUCorePractitionerRole A person with formal responsibility in a role providing one or more services
This profile also complies with the profile PractitionerRole (IPS)
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SOΣ 0..* Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber Business Identifiers that are specific to a role/location
Slice: Unordered, Open by pattern:type
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... identifier:medicareProvider SOΣ 0..1 AUMedicareProviderNumber Business Identifiers that are specific to a role/location
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... active Σ 0..1 boolean Whether this practitioner role record is in active use
... period Σ 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
... practitioner SOΣC 1..1 Reference(AU PS Practitioner) Practitioner that is able to provide the defined services for the organization
Constraints: au-core-prarol-01
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... organization SOΣ 0..1 Reference(AU PS Organization) Organization where the roles are available
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... code SOΣ 0..* CodeableConceptIPS Roles which this practitioner may perform
Binding: Practitioner Role . (preferred)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... specialty SOΣ 0..* CodeableConceptIPS Specific specialty of the practitioner
Binding: Clinical Specialty . (preferred)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
... location Σ 0..* Reference(Location) The location(s) at which this practitioner provides care
... healthcareService 0..* Reference(HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SOΣ 0..* ContactPoint Contact details that are specific to the role/location/service
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SOΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SOΣ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... availableTime 0..* BackboneElement Times the Service Site is available
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.
.... allDay 0..1 boolean Always available? e.g. 24 hour service
.... availableStartTime 0..1 time Opening time of day (ignored if allDay = true)
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:timeZone 0..1 code IANA Timezone Code per BCP 175
URL: http://hl7.org/fhir/StructureDefinition/timezone
Binding: IANATimezones (required): IANA Timezones (BCP 175)
..... value 0..1 time Primitive value for time
.... availableEndTime 0..1 time Closing time of day (ignored if allDay = true)
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:timeZone 0..1 code IANA Timezone Code per BCP 175
URL: http://hl7.org/fhir/StructureDefinition/timezone
Binding: IANATimezones (required): IANA Timezones (BCP 175)
..... value 0..1 time Primitive value for time
... notAvailable 0..* BackboneElement Not available during this time due to provided reason
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description 1..1 string Reason presented to the user explaining why time not available
.... during 0..1 Period Service not available from this date
... availabilityExceptions 0..1 string Description of availability exceptions
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
PractitionerRole.codepreferredPractitionerRole .
https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
PractitionerRole.specialtypreferredClinicalSpecialty .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1
PractitionerRole.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
PractitionerRole.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
au-core-prarol-01errorPractitionerRole.practitionerAt least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present
: (reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
dom-2errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerRoleIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerRoleA resource should have narrative for robust management
: text.`div`.exists()
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()

 

Other representations of profile: CSV, Excel, Schematron