AU Core Implementation Guide
0.3.0-ballot - R1
This page is part of the AU Core (v0.3.0-ballot: AU Core R1 Ballot 5) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole | Version: 0.3.0-ballot | |||
Standards status: Draft | Maturity Level: 0 | Computable Name: AUCorePractitionerRole | ||
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 to record, search, and fetch a practitioner role for a practitioner associated with a patient. It is based on the AU Base Practitioner Role profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the PractitionerRole resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.
The following are supported usage scenarios for this profile:
A resource conforming to this profile is conformant to:
Conformance in reverse is not guaranteed, i.e. a resource conforming to International Patient Access, International Patient Summary, or US Core MAY NOT conform to AU Core.
Feedback is requested to remove Must Support from PractitionerRole.location. Please comment on HL7 Jira FHIR-43841.
Feedback is requested on following search considerations:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBasePractitionerRole
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PractitionerRole | 0..* | AUBasePractitionerRole | A person with formal responsibility in a role providing one or more services | |
Slices for identifier | S | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type |
identifier:medicareProvider | S | 0..1 | AUMedicareProviderNumber | Medicare Provider Number |
practitioner | SC | 1..1 | Reference(AU Core Practitioner) | Practitioner that is able to provide the defined services for the organization au-core-prarol-01: At least a reference, identifier or display shall be present |
organization | S | 0..1 | Reference(AU Core Organization) | Organization where the roles are available |
code | S | 0..* | CodeableConcept | Roles which this practitioner may perform |
specialty | S | 0..* | CodeableConcept | Specific specialty of the practitioner |
location | S | 0..* | Reference(AU Core Location) | The location(s) at which this practitioner provides care |
telecom | S | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
au-core-prarol-01 | error | PractitionerRole.practitioner | At least a reference, identifier or display shall be present : reference.exists() or identifier.exists() or display.exists() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PractitionerRole | 0..* | AUBasePractitionerRole | A person with formal responsibility in a role providing one or more services | |
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 | S | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type |
identifier:medicareProvider | S | 0..1 | AUMedicareProviderNumber | Medicare Provider Number |
practitioner | SΣC | 1..1 | Reference(AU Core Practitioner) | Practitioner that is able to provide the defined services for the organization au-core-prarol-01: At least a reference, identifier or display shall be present |
organization | SΣ | 0..1 | Reference(AU Core Organization) | Organization where the roles are available |
code | SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (preferred) |
specialty | SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Clinical Specialty (preferred) |
location | SΣ | 0..* | Reference(AU Core Location) | The location(s) at which this practitioner provides care |
telecom | SΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
Documentation for this format |
Path | Conformance | ValueSet | URI |
PractitionerRole.code | preferred | PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | |
PractitionerRole.specialty | preferred | ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 |
Id | Grade | Path(s) | Details | Requirements |
au-core-prarol-01 | error | PractitionerRole.practitioner | At least a reference, identifier or display shall be present : reference.exists() or identifier.exists() or display.exists() | |
dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | PractitionerRole | 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() | |
dom-4 | error | PractitionerRole | 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() | |
dom-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
PractitionerRole | 0..* | AUBasePractitionerRole | A person with formal responsibility in a role providing one or more services | |||||
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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
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 | S | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type | ||||
identifier:medicareProvider | S | 0..1 | AUMedicareProviderNumber | Medicare Provider Number | ||||
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 | SΣC | 1..1 | Reference(AU Core Practitioner) | Practitioner that is able to provide the defined services for the organization au-core-prarol-01: At least a reference, identifier or display shall be present | ||||
organization | SΣ | 0..1 | Reference(AU Core Organization) | Organization where the roles are available | ||||
code | SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (preferred) | ||||
specialty | SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Clinical Specialty (preferred) | ||||
location | SΣ | 0..* | Reference(AU Core 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 | SΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
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 | |||||
timeZone | 0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required) | |||||
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 | |||||
timeZone | 0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required) | |||||
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 | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
PractitionerRole.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
PractitionerRole.code | preferred | PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | ||||
PractitionerRole.specialty | preferred | ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 | ||||
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
au-core-prarol-01 | error | PractitionerRole.practitioner | At least a reference, identifier or display shall be present : reference.exists() or identifier.exists() or display.exists() | |
dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | PractitionerRole | 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() | |
dom-4 | error | PractitionerRole | 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() | |
dom-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from AUBasePractitionerRole
Summary
Mandatory: 1 element
Must-Support: 8 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Differential View
This structure is derived from AUBasePractitionerRole
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PractitionerRole | 0..* | AUBasePractitionerRole | A person with formal responsibility in a role providing one or more services | |
Slices for identifier | S | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type |
identifier:medicareProvider | S | 0..1 | AUMedicareProviderNumber | Medicare Provider Number |
practitioner | SC | 1..1 | Reference(AU Core Practitioner) | Practitioner that is able to provide the defined services for the organization au-core-prarol-01: At least a reference, identifier or display shall be present |
organization | S | 0..1 | Reference(AU Core Organization) | Organization where the roles are available |
code | S | 0..* | CodeableConcept | Roles which this practitioner may perform |
specialty | S | 0..* | CodeableConcept | Specific specialty of the practitioner |
location | S | 0..* | Reference(AU Core Location) | The location(s) at which this practitioner provides care |
telecom | S | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
au-core-prarol-01 | error | PractitionerRole.practitioner | At least a reference, identifier or display shall be present : reference.exists() or identifier.exists() or display.exists() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PractitionerRole | 0..* | AUBasePractitionerRole | A person with formal responsibility in a role providing one or more services | |
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 | S | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type |
identifier:medicareProvider | S | 0..1 | AUMedicareProviderNumber | Medicare Provider Number |
practitioner | SΣC | 1..1 | Reference(AU Core Practitioner) | Practitioner that is able to provide the defined services for the organization au-core-prarol-01: At least a reference, identifier or display shall be present |
organization | SΣ | 0..1 | Reference(AU Core Organization) | Organization where the roles are available |
code | SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (preferred) |
specialty | SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Clinical Specialty (preferred) |
location | SΣ | 0..* | Reference(AU Core Location) | The location(s) at which this practitioner provides care |
telecom | SΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
Documentation for this format |
Path | Conformance | ValueSet | URI |
PractitionerRole.code | preferred | PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | |
PractitionerRole.specialty | preferred | ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 |
Id | Grade | Path(s) | Details | Requirements |
au-core-prarol-01 | error | PractitionerRole.practitioner | At least a reference, identifier or display shall be present : reference.exists() or identifier.exists() or display.exists() | |
dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | PractitionerRole | 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() | |
dom-4 | error | PractitionerRole | 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() | |
dom-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
PractitionerRole | 0..* | AUBasePractitionerRole | A person with formal responsibility in a role providing one or more services | |||||
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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
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 | S | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type | ||||
identifier:medicareProvider | S | 0..1 | AUMedicareProviderNumber | Medicare Provider Number | ||||
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 | SΣC | 1..1 | Reference(AU Core Practitioner) | Practitioner that is able to provide the defined services for the organization au-core-prarol-01: At least a reference, identifier or display shall be present | ||||
organization | SΣ | 0..1 | Reference(AU Core Organization) | Organization where the roles are available | ||||
code | SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (preferred) | ||||
specialty | SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Clinical Specialty (preferred) | ||||
location | SΣ | 0..* | Reference(AU Core 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 | SΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
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 | |||||
timeZone | 0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required) | |||||
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 | |||||
timeZone | 0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required) | |||||
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 | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
PractitionerRole.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
PractitionerRole.code | preferred | PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | ||||
PractitionerRole.specialty | preferred | ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 | ||||
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
au-core-prarol-01 | error | PractitionerRole.practitioner | At least a reference, identifier or display shall be present : reference.exists() or identifier.exists() or display.exists() | |
dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | PractitionerRole | 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() | |
dom-4 | error | PractitionerRole | 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() | |
dom-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from AUBasePractitionerRole
Summary
Mandatory: 1 element
Must-Support: 8 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters and combined search parameters. FHIR search operations and the syntax used to describe the interactions is described here.
Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.
Parameter(s) | Conformance | Type(s) | Requirements (when used alone or in combination) |
---|---|---|---|
identifier | SHALL | token |
The client SHALL provide at least a code value and SHOULD provide both the system and code values. The server SHALL support both. The client SHOULD support search using a Medicare Provider Number identifier as defined in the profile. The server SHOULD support search using a Medicare Provider Number identifier as defined in the profile. |
practitioner | SHALL | reference |
The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both. |
_id | SHOULD | token |
|
practitioner.identifier | SHOULD | token |
The client SHALL provide at least a code value and SHOULD provide both the system and code values. The server SHALL support both. The client SHOULD support search using a HPI-I identifier as defined in the profile. The server SHOULD support search using the using a HPI-I identifier as defined in the profile. |
specialty | SHOULD | token |
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
organization | MAY | reference |
The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both. |
The following search parameters SHALL be supported:
identifier
search parameter:
_include
parameters: PractitionerRole:practitioner
GET [base]/PractitionerRole?identifier={system|}[code]
Example:
Implementation Notes: Fetches a bundle containing any PractitionerRole resources matching the identifier (how to search by token)
practitioner
search parameters:
practitioner.identifier
(e.g. practitioner.identifier=[system|][code]
)_include
parameters: PractitionerRole:practitioner
GET [base]/PractitionerRole?practitioner={Type/}[id]
Example:
Implementation Notes: Fetches a bundle of all PractitionerRole resources matching the specified practitioner (how to search by reference)
The following search parameters and search parameter combinations SHOULD be supported:
_id
search parameter:
_revinclude
parameters: Provenance:target
_include
parameters: PractitionerRole:practitioner
GET [base]/PractitionerRole/[id]
or GET [base]/PractitionerRole?_id=[id]
Example:
Implementation Notes: Returns a single PractitionerRole resource. (how to search by the logical id of the resource)
specialty
search parameter:
_include
parameters: PractitionerRole:practitioner
GET [base]/PractitionerRole?specialty={system|}[code]
Example:
Implementation Notes: Fetches a bundle of all PractitionerRole resources for the specified specialty (how to search by token)