Generated Narrative: StructureDefinition hcpd-practitionerrole Name Flags Card. Type Description & Constraints PractitionerRole <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( inv-01-identifier-registration-required, inv-02-identifier-registration-match )">C 0..* AUCorePractitionerRole(2.0.0) A person with formal responsibility in a role providing one or more services #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:suppressed SO 0..1 (Complex) Indicates whether the PractitionerRole should be hidden. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor #xD; Slices for extension Content/Rules for all slices #xD; extension:suppressedBy 1..1 Extension Extension #xD; value[x] #xD; coding S 1..2 Coding Code defined by a terminology system #xD; extension:practitioner-role-communication SO 0..* CodeableConcept Practitioner role communication preferences URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/practitioner-role-communication Binding: Common Languages in Australia (required) Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor #xD; extension:alternate-name SO 0..1 HumanName Alternate name for this practitioner role URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/alternate-name Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor #xD; Slices for identifier O 1..* Identifier(4.0.1), AUMedicareProviderNumber(6.0.0), AUNationalProviderIdentifierAtOrganisation(6.0.0), AUEmployeeNumber(6.0.0) Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor #xD; identifier:medicareProvider O 0..1 AUMedicareProviderNumber(6.0.0) Medicare provider number Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor #xD; identifier:HCPD_Local_Identifier S 1..1 HCPD_Local_Identifier(26.0.0) Local identifier for the PractitionerRole attributed by HC #xD; identifier:peakbodyregistrationnumber S 0..1 Peak_Body_Professional_Registration_Number(26.0.0) Professional association / Peak body association (for non-Ahpra registered practitioners), as recorded against the HPI-I record #xD; identifier:ahpraregistrationnumber S 0..1 AUAhpraRegistrationNumber(6.0.0) Ahpra Registration Number #xD; period SO 0..1 Period The period during which the practitioner is active in this role. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor #xD; practitioner O 1..1 Reference(HCPD Practitioner(26.0.0)) Practitioner in the role Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole #xD; organization O 1..1 Reference(HCPD Organization(26.0.0)) Organisation providing this role. Reference to be the same organisation as the referenced HealthcareService for this role. Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole #xD; code O 1..1 CodeableConcept The primary role of the practitioner Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor #xD; location SO 1..1 Reference(HCPD Location(26.0.0)) Location at which this role is provided. Reference to be the same Location as the referenced HealthcareService for this role. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor #xD; healthcareService SO 1..1 Reference(HCPD HealthcareService(26.0.0)) Healthcare service at which this role is provided. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor #xD; telecom 0..* ContactPoint Contact details for the practitioner in this role. #xD; availableTime SO 0..* BackboneElement Times that the practitioner provides the healthcare service in this role at this location. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor #xD; daysOfWeek SO 0..* code mon | tue | wed | thu | fri | sat | sun Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor #xD; allDay SO 0..1 boolean Always available? e.g. 24 hour service Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor #xD; availableStartTime SO 0..1 time Opening time of day (ignored if allDay = true) Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor #xD; availableEndTime SO 0..1 time Closing time of day (ignored if allDay = true) Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor #xD; endpoint SO 0..* Reference(HCPD Endpoint(26.0.0)) Technical endpoints for this practitioner role. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor #xD; Documentation for this format
This profile defines a Health Connect Provider Directory entry for a practitioner role within an organisation.
This profile addresses the business requirement to define practitioner roles within healthcare organizations in the provider directory, enabling the representation of practitioner-organization-location relationships and associated service offerings for referral and directory search purposes.
This content is licensed under a Creative Commons Attribution 4.0 International License. See [https://creativecommons.org/licenses/by/4.0/](https://creativecommons.org/licenses/by/4.0/)
A person with formal responsibility in a role providing one or more services
Directory entry for a provider at a location for an organisation.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
If 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()
not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
If 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()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
Either Ahpra or PRN identifier SHALL exist, but not both. While a practitioner can have more than one professional registration and professions (e.g. nurse and midwife), the relevant registration that is applicable for this role only is captured.
(identifier.type.coding.where(code = 'AHPRA').exists() and identifier.type.coding.where(code = 'PRN').exists().not()) or (identifier.type.coding.where(code = 'PRN').exists() and identifier.type.coding.where(code = 'AHPRA').exists().not())
PractitionerRole registration identifiers SHOULD match with the referenced Practitioner's registration identifiers in qualifications
practitioner.resolve().qualification.identifier.where(type.coding.where(code = 'AHPRA').exists()).value.intersect(identifier.where(type.coding.where(code = 'AHPRA').exists()).value).exists() or practitioner.resolve().qualification.identifier.where(type.coding.where(code = 'PRN').exists()).value.intersect(identifier.where(type.coding.where(code = 'PRN').exists()).value).exists()
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Text summary of the resource, for human interpretation
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
Indicates whether the PractitionerRole should be hidden.
A coded value, when present, indicates whether the PractitionerRole should be hidden from display in the Provider Directory.
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
Source of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).
Additional content defined by implementations
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
A reference to a code defined by a terminology system.
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Allows for alternative encodings within a code system, and translations to other code systems.
fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Plain text representation of the concept
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Very often the text is the same as a displayName of one of the codings.
The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
C*E.9. But note many systems use C*E.2 for this
fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Practitioner role communication preferences
Communication preferences and available modes for a practitioner in this role.
Alternate name for this practitioner role
Name by which a practitioner chooses to be known in the context of the delivery of a specific healthcare service.
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Business Identifiers that are specific to a role/location
Business Identifiers that are specific to a role/location.
Often, specific identities are assigned for the agent.
Local identifier for the PractitionerRole attributed by HC
Local identifier for the PractitionerRole attributed by Health Connect. Used for system reference and internal business logic.
Professional association / Peak body association (for non-Ahpra registered practitioners), as recorded against the HPI-I record
Whether this practitioner role record is in active use
Whether this practitioner role record is in active use.
If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.
Need to be able to mark a practitioner role record as not to be used because it was created in error, or otherwise no longer in active use.
This resource is generally assumed to be active if no value is provided for the active element
The period during which the practitioner is active in this role.
The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
Even after the agencies is revoked, the fact that it existed must still be recorded.
.performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime
(ServD maps Practitioners and Organizations via another entity, so this concept is not available)
Australian practitioner directory entry in this role.
At 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()
(exists(f:reference) or exists(f:display) or exists(f:identifier)) and not(exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/data-absent-reason'])) or not(exists(f:reference) or exists(f:display) or exists(f:identifier)) and exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/data-absent-reason'])
Organisation providing this role. Reference to be the same organisation as the referenced HealthcareService for this role.
Australian organisation directory entry providing this role.
Roles which this practitioner is authorized to perform for the organization.
Need to know what authority the practitioner has - what can they do?
.player.HealthCareProvider[@classCode = 'PROV'].code
Location at which this role is provided. Reference to be the same Location as the referenced HealthcareService for this role.
Location details describing where the role is being provided.
.performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC']
(ServD maps Practitioners and Organizations via another entity, so this concept is not available) However these are accessed via the Site.ServiceSite.ServiceSiteProvider record. (The Site has the location)
Healthcare service at which this role is provided.
Healthcare details describing where the role is being provided.
.player.QualifiedEntity[@classCode = 'QUAL'].code
Contact details for the practitioner in this role.
Details for contacting the practitioner in this role.
Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.
phone | fax | email | pager | url | sms | other
Telecommunications form for contact point - what communications system is required to make use of the contact.
Telecommunications form for contact point.
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Need to support legacy numbers that are not in a tightly controlled format.
home | work | temp | old | mobile - purpose of this contact point
Identifies the purpose for the contact point.
Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
Specify preferred order of use (1 = highest)
Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Time period when the contact point was/is in use
Time period when the contact point was/is in use.
Times that the practitioner provides the healthcare service in this role at this location.
More detailed availability information may be provided in associated Schedule/Slot resources.
Extensions that cannot be ignored even if unrecognized
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Indicates which days of the week are available between the start and end Times.
Is this always available? (hence times are irrelevant) e.g. 24 hour service.
Opening time of day (ignored if allDay = true)
The opening time of day. Note: If the AllDay flag is set, then this time is ignored.
The timezone is expected to be for where this HealthcareService is provided at.
unique id for the element within a resource (for internal references)
An IANA timezone code for the timezone offset per BCP 175. For data types allowing the offset (all except date and time), this extension SHALL agree with the offset if provided and cannot be used in place of the offset if the precision expressed requires an offset. Where an offset is provided, this extension provides a more legible display of the zone associated with the offset. Where an offset is not present, this extension can be used to provide zone information not otherwise available.
Use [Australian Time Zone Usage](https://hl7.org.au/fhir/6.0.0/StructureDefinition-au-timezone-usage.html) for Australian state and territory time zone offsets.
Closing time of day (ignored if allDay = true)
The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
Not available during this time due to provided reason
The practitioner is not available or performing this role during this period of time due to the provided reason.
Reason presented to the user explaining why time not available
The reason that can be presented to the user as to why this time is not available.
Service is not available (seasonally or for a public holiday) from this date.
A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
Technical endpoints for this practitioner role.
Details for service based communication with the practitioner in this role. This can include web services, messaging profiles and other protocol based communication.
Organizations have multiple systems that provide various services and ,ay also be different for practitioners too. So the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose.
Slice based on identifier system: must include at least one HCPD Location Identifier known to this profile