AU Patient Summary Implementation Guide
0.1.0-cibuild - CI Build
AU Patient Summary Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 0.1.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/draft-au-patient-summary/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org.au.draft/fhir/aups/StructureDefinition/au-ps-practitionerrole | Version: 0.1.0-cibuild | |||
Standards status: Informative | 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 is based on the AU Core profile, with IPS rules added as well (by reference to the IPS profile).
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUCorePractitionerRole
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PractitionerRole | AUCorePractitionerRole | This profile also imposes the profile PractitionerRole (IPS) | ||
practitioner | 1..1 | Reference(AU Patient Summary Practitioner) | Practitioner that is able to provide the defined services for the organization | |
organization | 0..1 | Reference(AU Patient Summary Organization) | Organization where the roles are available | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
PractitionerRole | 0..* | AUCorePractitionerRole | A person with formal responsibility in a role providing one or more services This profile also imposes 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
| ||||||
identifier:medicareProvider | SO | 0..1 | AUMedicareProviderNumber | Medicare Provider Number
| ||||||
practitioner | SOΣC | 1..1 | Reference(AU Patient Summary 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, or, if neither is available, the Data Absent Reason extension shall be present
| ||||||
organization | SOΣ | 0..1 | Reference(AU Patient Summary Organization) | Organization where the roles are available
| ||||||
code | SOΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (preferred)
| ||||||
specialty | SOΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Clinical Specialty (preferred)
| ||||||
telecom | SOΣ | 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, 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-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..* | AUCorePractitionerRole | A person with formal responsibility in a role providing one or more services This profile also imposes 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 | ||||||
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 | SO | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
| ||||||
identifier:medicareProvider | SO | 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 | SOΣC | 1..1 | Reference(AU Patient Summary 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, or, if neither is available, the Data Absent Reason extension shall be present
| ||||||
organization | SOΣ | 0..1 | Reference(AU Patient Summary Organization) | Organization where the roles are available
| ||||||
code | SOΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (preferred)
| ||||||
specialty | SOΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Clinical Specialty (preferred)
| ||||||
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
| ||||||
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, 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-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 AUCorePractitionerRole
Summary
Structures
This structure refers to these other structures:
Maturity: 0
Differential View
This structure is derived from AUCorePractitionerRole
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PractitionerRole | AUCorePractitionerRole | This profile also imposes the profile PractitionerRole (IPS) | ||
practitioner | 1..1 | Reference(AU Patient Summary Practitioner) | Practitioner that is able to provide the defined services for the organization | |
organization | 0..1 | Reference(AU Patient Summary Organization) | Organization where the roles are available | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
PractitionerRole | 0..* | AUCorePractitionerRole | A person with formal responsibility in a role providing one or more services This profile also imposes 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
| ||||||
identifier:medicareProvider | SO | 0..1 | AUMedicareProviderNumber | Medicare Provider Number
| ||||||
practitioner | SOΣC | 1..1 | Reference(AU Patient Summary 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, or, if neither is available, the Data Absent Reason extension shall be present
| ||||||
organization | SOΣ | 0..1 | Reference(AU Patient Summary Organization) | Organization where the roles are available
| ||||||
code | SOΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (preferred)
| ||||||
specialty | SOΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Clinical Specialty (preferred)
| ||||||
telecom | SOΣ | 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, 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-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..* | AUCorePractitionerRole | A person with formal responsibility in a role providing one or more services This profile also imposes 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 | ||||||
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 | SO | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
| ||||||
identifier:medicareProvider | SO | 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 | SOΣC | 1..1 | Reference(AU Patient Summary 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, or, if neither is available, the Data Absent Reason extension shall be present
| ||||||
organization | SOΣ | 0..1 | Reference(AU Patient Summary Organization) | Organization where the roles are available
| ||||||
code | SOΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (preferred)
| ||||||
specialty | SOΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Clinical Specialty (preferred)
| ||||||
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
| ||||||
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, 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-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 AUCorePractitionerRole
Summary
Structures
This structure refers to these other structures:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron