MediRecords FHIR Implementation Guide
1.3.0 - release
| Defining URL: | https://fhir.medirecords.com/StructureDefinition/mr-practitioner-role-contact |
| Version: | 1.3.0 |
| Name: | MRPractitionerRoleContact |
| Title: | MR PractitionerRole Contact |
| Status: | Active as of 2023-09-15 01:10:47+0000 |
| Definition: | MediRecords PractitionerRole profile representing external health professional contact |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://fhir.medirecords.com/StructureDefinition/mr-practitioner-role-contact
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBasePractitionerRole
Summary
Mandatory: 4 elements (16 nested mandatory elements)
Must-Support: 20 elements
Fixed Value: 10 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from AUBasePractitionerRole
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  PractitionerRole | 0..* | AUBasePractitionerRole | A practitioner in a healthcare role in an Australian healthcare context | |
  meta | ||||
  lastUpdated | S | 0..1 | instant | When the resource version last changed |
 profile | S | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
 Slices for contained | 0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
  contained:practitioner | S | 0..1 | MRPractitionerContact | Practitioner resource representing an external health professional (contact) |
 contained:location | S | 0..1 | MRLocation | Location resource representing an external health professional's location (address) |
  address | ||||
| line | 1..2 | string | Street name, number, direction & P.O. Box etc. | |
| Slices for identifier | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Closed by pattern:type | |
 identifier:identifierAUMedicare | S | 0..1 | AUMedicareProviderNumber | Medicare Provider Number |
| active | S | 1..1 | boolean | Whether this practitioner role record is in active use |
 practitioner | S | 1..1 | Reference(MR Practitioner Contact) | Contained resource reference to an external health professional (contact). |
| organization | S | 0..1 | Reference(MediRecords Core Organisation) | Optional reference to an external service provider (account). |
| code | S | 1..1 | CodeableConcept | Provider category Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (extensible) |
| coding | 0..1 | Coding | Coded practitioner role | |
| text | 1..1 | string | Provider category description | |
| location | S | 0..1 | Reference(MediRecords Core Location) | Contained resource reference to external health professional's location (address) |
 Slices for telecom | 0..* | ContactPoint | Contact details that are specific to the role/location/service Slice: Unordered, Closed by value:use, value:system | |
 telecom:workPhone | S | 0..1 | ContactPoint | Work Phone. The number should be of maximum 20 digits length |
  system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
| value | S | 1..1 | string | The actual contact point details Max Length: 20 |
 use | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work | |
| telecom:fax | S | 0..1 | ContactPoint | Fax. The number should be of maximum 20 digits length |
| system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: fax | |
| value | S | 1..1 | string | The actual contact point details Max Length: 20 |
| use | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work | |
| telecom:mobile | S | 0..1 | ContactPoint | Mobile. The number should be of maximum 20 digits length |
| system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
| value | S | 1..1 | string | The actual contact point details Max Length: 20 |
| use | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: mobile | |
| telecom:pager | S | 0..1 | ContactPoint | Pager. The number should be of maximum 20 digits length |
| system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: pager | |
| value | S | 1..1 | string | The actual contact point details Max Length: 20 |
| use | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work | |
| telecom:email | S | 0..1 | ContactPoint | |
| system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email | |
| value | S | 1..1 | string | The actual contact point details |
| use | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| PractitionerRole | 0..* | AUBasePractitionerRole | A practitioner in a healthcare role in an Australian healthcare context | |||||
 id | Σ | 0..1 | id | Logical id of this artifact | ||||
 meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
 extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | SΣ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | SΣ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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 | |||||
| Slices for contained | 0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |||||
| contained:practitioner | S | 0..1 | MRPractitionerContact | Practitioner resource representing an external health professional (contact) | ||||
| contained:location | S | 0..1 | MRLocation | Location resource representing an external health professional's location (address) | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
 meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | SΣ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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 | ||||
| identifier | 0..* | Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber | Unique code or number identifying the location to its users | |||||
| status | ?!SΣ | 1..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. | ||||
| operationalStatus | Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room). | ||||
| name | Σ | 0..1 | string | Name of the location as used by humans | ||||
| alias | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past | |||||
| description | Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name | ||||
| mode | Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. | ||||
| type | Σ | 0..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible) | ||||
| telecom | 0..* | ContactPoint | Contact details of the location | |||||
| address | SC | 1..1 | MRAddress, MRAusAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| isPrimary | S | 0..1 | boolean | Address Is Primary Extension URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line | SΣ | 1..2 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street Max Length: 50 | ||||
| city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon Max Length: 60 | ||||
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Max Length: 20 | ||||
| postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 Max Length: 10 | ||||
| country | SΣ | 0..1 | string | Use a 2 digit ISO 3166 country code Binding: Iso3166-1-2 (required) | ||||
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| physicalType | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: Location Type (Physical) - AU Extended (preferred) | ||||
| position | 0..1 | BackboneElement | The absolute geographic location | |||||
| 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 | ||||
| longitude | 1..1 | decimal | Longitude with WGS84 datum | |||||
| latitude | 1..1 | decimal | Latitude with WGS84 datum | |||||
| altitude | 0..1 | decimal | Altitude with WGS84 datum | |||||
| managingOrganization | Σ | 0..1 | Reference(Organization) | Organization responsible for provisioning and upkeep | ||||
| partOf | 0..1 | Reference(Location) | Another Location this one is physically a part of | |||||
| hoursOfOperation | 0..* | BackboneElement | What days/times during a week is this location usually open | |||||
| 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 | The Location is open all day | |||||
| openingTime | 0..1 | time | Time that the Location opens | |||||
| closingTime | 0..1 | time | Time that the Location closes | |||||
| availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Closed by pattern:type | |||||
| identifier:identifierAUMedicare | S | 0..1 | AUMedicareProviderNumber | Medicare Provider Number | ||||
| active | SΣ | 1..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Σ | 1..1 | Reference(MR Practitioner Contact) | Contained resource reference to an external health professional (contact). | ||||
| organization | SΣ | 0..1 | Reference(MediRecords Core Organisation) | Optional reference to an external service provider (account). | ||||
| code | SΣ | 1..1 | CodeableConcept | Provider category Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (extensible) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..1 | Coding | Coded practitioner role | ||||
| text | Σ | 1..1 | string | Provider category description | ||||
| specialty | Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred) | ||||
| location | SΣ | 0..1 | Reference(MediRecords Core Location) | Contained resource reference to external health professional's location (address) | ||||
| healthcareService | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |||||
| Slices for telecom | Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service Slice: Unordered, Closed by value:use, value:system | ||||
| telecom:workPhone | SΣ | 0..1 | ContactPoint | Work Phone. The number should be of maximum 20 digits length | ||||
| 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 | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
| value | SΣ | 1..1 | string | The actual contact point details Max Length: 20 | ||||
| use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
| 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 | ||||
| telecom:fax | SΣ | 0..1 | ContactPoint | Fax. The number should be of maximum 20 digits length | ||||
| 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 | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: fax | ||||
| value | SΣ | 1..1 | string | The actual contact point details Max Length: 20 | ||||
| use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
| 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 | ||||
| telecom:mobile | SΣ | 0..1 | ContactPoint | Mobile. The number should be of maximum 20 digits length | ||||
| 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 | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
| value | SΣ | 1..1 | string | The actual contact point details Max Length: 20 | ||||
| use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile | ||||
| 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 | ||||
| telecom:pager | SΣ | 0..1 | ContactPoint | Pager. The number should be of maximum 20 digits length | ||||
| 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 | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: pager | ||||
| value | SΣ | 1..1 | string | The actual contact point details Max Length: 20 | ||||
| use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
| 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 | ||||
| telecom:email | SΣ | 0..1 | ContactPoint | Email | ||||
| 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 | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
| value | SΣ | 1..1 | string | The actual contact point details | ||||
| use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
| 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 | |||||
| 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 | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole | 0..* | AUBasePractitionerRole | A practitioner in a healthcare role in an Australian healthcare context | |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| contained:practitioner | 0..1 | MRPractitionerContact | Practitioner resource representing an external health professional (contact) | |
| contained:location | 0..1 | MRLocation | Location resource representing an external health professional's location (address) | |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| status | ?!Σ | 1..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
| address | C | 1..1 | MRAddress, MRAusAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
| isPrimary | 0..1 | boolean | Address Is Primary Extension URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn | |
| line | Σ | 1..2 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Max Length: 50 |
| city | Σ | 0..1 | string | Name of city, town etc. Max Length: 60 |
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Max Length: 20 |
| postalCode | Σ | 0..1 | string | Postal code for area Max Length: 10 |
| country | Σ | 0..1 | string | Use a 2 digit ISO 3166 country code Binding: Iso3166-1-2 (required) |
| identifier:identifierAUMedicare | 0..1 | AUMedicareProviderNumber | Medicare Provider Number | |
| active | Σ | 1..1 | boolean | Whether this practitioner role record is in active use |
| practitioner | Σ | 1..1 | Reference(MR Practitioner Contact) | Contained resource reference to an external health professional (contact). |
| organization | Σ | 0..1 | Reference(MediRecords Core Organisation) | Optional reference to an external service provider (account). |
| code | Σ | 1..1 | CodeableConcept | Provider category Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (extensible) |
| location | Σ | 0..1 | Reference(MediRecords Core Location) | Contained resource reference to external health professional's location (address) |
| telecom:workPhone | Σ | 0..1 | ContactPoint | Work Phone. The number should be of maximum 20 digits length |
| value | Σ | 1..1 | string | The actual contact point details Max Length: 20 |
| telecom:fax | Σ | 0..1 | ContactPoint | Fax. The number should be of maximum 20 digits length |
| value | Σ | 1..1 | string | The actual contact point details Max Length: 20 |
| telecom:mobile | Σ | 0..1 | ContactPoint | Mobile. The number should be of maximum 20 digits length |
| value | Σ | 1..1 | string | The actual contact point details Max Length: 20 |
| telecom:pager | Σ | 0..1 | ContactPoint | Pager. The number should be of maximum 20 digits length |
| value | Σ | 1..1 | string | The actual contact point details Max Length: 20 |
| telecom:email | Σ | 0..1 | ContactPoint | Email |
| value | Σ | 1..1 | string | The actual contact point details |
| Documentation for this format | ||||
This structure is derived from AUBasePractitionerRole
Summary
Mandatory: 4 elements (16 nested mandatory elements)
Must-Support: 20 elements
Fixed Value: 10 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from AUBasePractitionerRole
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole | 0..* | AUBasePractitionerRole | A practitioner in a healthcare role in an Australian healthcare context | |
| meta | ||||
| lastUpdated | S | 0..1 | instant | When the resource version last changed |
| profile | S | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| Slices for contained | 0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
| contained:practitioner | S | 0..1 | MRPractitionerContact | Practitioner resource representing an external health professional (contact) |
| contained:location | S | 0..1 | MRLocation | Location resource representing an external health professional's location (address) |
| address | ||||
| line | 1..2 | string | Street name, number, direction & P.O. Box etc. | |
| Slices for identifier | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Closed by pattern:type | |
| identifier:identifierAUMedicare | S | 0..1 | AUMedicareProviderNumber | Medicare Provider Number |
| active | S | 1..1 | boolean | Whether this practitioner role record is in active use |
| practitioner | S | 1..1 | Reference(MR Practitioner Contact) | Contained resource reference to an external health professional (contact). |
| organization | S | 0..1 | Reference(MediRecords Core Organisation) | Optional reference to an external service provider (account). |
| code | S | 1..1 | CodeableConcept | Provider category Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (extensible) |
| coding | 0..1 | Coding | Coded practitioner role | |
| text | 1..1 | string | Provider category description | |
| location | S | 0..1 | Reference(MediRecords Core Location) | Contained resource reference to external health professional's location (address) |
| Slices for telecom | 0..* | ContactPoint | Contact details that are specific to the role/location/service Slice: Unordered, Closed by value:use, value:system | |
| telecom:workPhone | S | 0..1 | ContactPoint | Work Phone. The number should be of maximum 20 digits length |
| system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
| value | S | 1..1 | string | The actual contact point details Max Length: 20 |
| use | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work | |
| telecom:fax | S | 0..1 | ContactPoint | Fax. The number should be of maximum 20 digits length |
| system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: fax | |
| value | S | 1..1 | string | The actual contact point details Max Length: 20 |
| use | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work | |
| telecom:mobile | S | 0..1 | ContactPoint | Mobile. The number should be of maximum 20 digits length |
| system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
| value | S | 1..1 | string | The actual contact point details Max Length: 20 |
| use | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: mobile | |
| telecom:pager | S | 0..1 | ContactPoint | Pager. The number should be of maximum 20 digits length |
| system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: pager | |
| value | S | 1..1 | string | The actual contact point details Max Length: 20 |
| use | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work | |
| telecom:email | S | 0..1 | ContactPoint | |
| system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email | |
| value | S | 1..1 | string | The actual contact point details |
| use | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| PractitionerRole | 0..* | AUBasePractitionerRole | A practitioner in a healthcare role in an Australian healthcare context | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | SΣ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | SΣ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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 | |||||
| Slices for contained | 0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |||||
| contained:practitioner | S | 0..1 | MRPractitionerContact | Practitioner resource representing an external health professional (contact) | ||||
| contained:location | S | 0..1 | MRLocation | Location resource representing an external health professional's location (address) | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | SΣ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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 | ||||
| identifier | 0..* | Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber | Unique code or number identifying the location to its users | |||||
| status | ?!SΣ | 1..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. | ||||
| operationalStatus | Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room). | ||||
| name | Σ | 0..1 | string | Name of the location as used by humans | ||||
| alias | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past | |||||
| description | Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name | ||||
| mode | Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. | ||||
| type | Σ | 0..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible) | ||||
| telecom | 0..* | ContactPoint | Contact details of the location | |||||
| address | SC | 1..1 | MRAddress, MRAusAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| isPrimary | S | 0..1 | boolean | Address Is Primary Extension URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line | SΣ | 1..2 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street Max Length: 50 | ||||
| city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon Max Length: 60 | ||||
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Max Length: 20 | ||||
| postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 Max Length: 10 | ||||
| country | SΣ | 0..1 | string | Use a 2 digit ISO 3166 country code Binding: Iso3166-1-2 (required) | ||||
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| physicalType | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: Location Type (Physical) - AU Extended (preferred) | ||||
| position | 0..1 | BackboneElement | The absolute geographic location | |||||
| 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 | ||||
| longitude | 1..1 | decimal | Longitude with WGS84 datum | |||||
| latitude | 1..1 | decimal | Latitude with WGS84 datum | |||||
| altitude | 0..1 | decimal | Altitude with WGS84 datum | |||||
| managingOrganization | Σ | 0..1 | Reference(Organization) | Organization responsible for provisioning and upkeep | ||||
| partOf | 0..1 | Reference(Location) | Another Location this one is physically a part of | |||||
| hoursOfOperation | 0..* | BackboneElement | What days/times during a week is this location usually open | |||||
| 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 | The Location is open all day | |||||
| openingTime | 0..1 | time | Time that the Location opens | |||||
| closingTime | 0..1 | time | Time that the Location closes | |||||
| availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Closed by pattern:type | |||||
| identifier:identifierAUMedicare | S | 0..1 | AUMedicareProviderNumber | Medicare Provider Number | ||||
| active | SΣ | 1..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Σ | 1..1 | Reference(MR Practitioner Contact) | Contained resource reference to an external health professional (contact). | ||||
| organization | SΣ | 0..1 | Reference(MediRecords Core Organisation) | Optional reference to an external service provider (account). | ||||
| code | SΣ | 1..1 | CodeableConcept | Provider category Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (extensible) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..1 | Coding | Coded practitioner role | ||||
| text | Σ | 1..1 | string | Provider category description | ||||
| specialty | Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred) | ||||
| location | SΣ | 0..1 | Reference(MediRecords Core Location) | Contained resource reference to external health professional's location (address) | ||||
| healthcareService | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |||||
| Slices for telecom | Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service Slice: Unordered, Closed by value:use, value:system | ||||
| telecom:workPhone | SΣ | 0..1 | ContactPoint | Work Phone. The number should be of maximum 20 digits length | ||||
| 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 | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
| value | SΣ | 1..1 | string | The actual contact point details Max Length: 20 | ||||
| use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
| 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 | ||||
| telecom:fax | SΣ | 0..1 | ContactPoint | Fax. The number should be of maximum 20 digits length | ||||
| 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 | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: fax | ||||
| value | SΣ | 1..1 | string | The actual contact point details Max Length: 20 | ||||
| use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
| 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 | ||||
| telecom:mobile | SΣ | 0..1 | ContactPoint | Mobile. The number should be of maximum 20 digits length | ||||
| 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 | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
| value | SΣ | 1..1 | string | The actual contact point details Max Length: 20 | ||||
| use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile | ||||
| 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 | ||||
| telecom:pager | SΣ | 0..1 | ContactPoint | Pager. The number should be of maximum 20 digits length | ||||
| 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 | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: pager | ||||
| value | SΣ | 1..1 | string | The actual contact point details Max Length: 20 | ||||
| use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
| 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 | ||||
| telecom:email | SΣ | 0..1 | ContactPoint | Email | ||||
| 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 | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
| value | SΣ | 1..1 | string | The actual contact point details | ||||
| use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
| 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 | |||||
| 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 | ||||||||