MediRecords FHIR Implementation Guide
1.4.1 - release


Resource Profile: MR PractitionerRole Contact

Defining URL:https://fhir.medirecords.com/StructureDefinition/mr-practitioner-role-contact
Version:1.4.1
Name:MRPractitionerRoleContact
Title:MR PractitionerRole Contact
Status:Active as of 2024-10-28 02:34:31+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

Formal Views of Profile Content

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:

  • The element PractitionerRole.contained is sliced based on the value of type:$this (Closed)
  • The element PractitionerRole.identifier is sliced based on the value of pattern:type (Closed)
  • The element PractitionerRole.telecom is sliced based on the values of value:use, value:system (Closed)

This structure is derived from AUBasePractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
​.. PractitionerRole AUBasePractitionerRole
​... meta
​.... lastUpdated S0..1instantWhen the resource version last changed
​.... profile S1..*canonical(StructureDefinition)Profiles this resource claims to conform to
​... Slices for contained 0..*ResourceContained, inline Resources
Slice: Unordered, Closed by type:$this
​.... contained:practitioner S0..1MRPractitionerContactPractitioner resource representing an external health professional (contact)
​.... contained:location S0..1MRLocationLocation resource representing an external health professional's location (address)
​..... address
​...... line 1..2stringStreet name, number, direction & P.O. Box etc.
​... Slices for identifier 0..*Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumberBusiness Identifiers that are specific to a role/location
Slice: Unordered, Closed by pattern:type
​.... identifier:identifierAUMedicare S0..1AUMedicareProviderNumberMedicare Provider Number
​... practitioner S1..1Reference(MR Practitioner Contact)Contained resource reference to an external health professional (contact).
​... organization S0..1Reference(MR Organisation)Optional reference to an external service provider (account).
​... code S1..1CodeableConceptProvider category
Binding: Practitioner Role . (extensible)
​.... coding 0..1CodingCoded practitioner role
​.... text 1..1stringProvider category description
​... location S0..1Reference(MR Location)Contained resource reference to external health professional's location (address)
​... Slices for telecom 0..*ContactPointContact details that are specific to the role/location/service
Slice: Unordered, Closed by value:use, value:system
​.... telecom:workPhone S0..1ContactPointWork Phone. The number should be of maximum 20 digits length
​..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
​..... value S1..1stringThe actual contact point details
Max Length: 20
​..... use 1..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: work
​.... telecom:fax S0..1ContactPointFax. The number should be of maximum 20 digits length
​..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: fax
​..... value S1..1stringThe actual contact point details
Max Length: 20
​..... use 1..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: work
​.... telecom:mobile S0..1ContactPointMobile. The number should be of maximum 20 digits length
​..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
​..... value S1..1stringThe actual contact point details
Max Length: 20
​..... use 1..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: mobile
​.... telecom:pager S0..1ContactPointPager. The number should be of maximum 20 digits length
​..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: pager
​..... value S1..1stringThe actual contact point details
Max Length: 20
​..... use 1..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: work
​.... telecom:email S0..1ContactPointEmail
​..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: email
​..... value S1..1stringThe actual contact point details
​..... use 1..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: work

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*AUBasePractitionerRoleA practitioner in a healthcare role in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile SΣ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... Slices for contained 0..*ResourceContained, inline Resources
Slice: Unordered, Closed by type:$this
.... contained:practitioner S0..1MRPractitionerContactPractitioner resource representing an external health professional (contact)
.... contained:location S0..1MRLocationLocation resource representing an external health professional's location (address)
..... id Σ0..1idLogical id of this artifact
..... meta Σ0..1MetaMetadata about the resource
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... versionId Σ0..1idVersion specific identifier
...... lastUpdated Σ0..1instantWhen the resource version last changed
...... source Σ0..1uriIdentifies where the resource comes from
...... profile SΣ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
...... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
..... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
..... text 0..1NarrativeText summary of the resource, for human interpretation
..... contained 0..*ResourceContained, inline Resources
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
..... identifier 0..*Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumberUnique code or number identifying the location to its users
..... status ?!SΣ1..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

..... operationalStatus Σ0..1CodingThe 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..1stringName of the location as used by humans
..... alias 0..*stringA list of alternate names that the location is known as, or was known as, in the past
..... description Σ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
..... mode Σ0..1codeinstance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

..... type Σ0..*CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
..... telecom 0..*ContactPointContact details of the location
..... address SC1..1MRAddress, MRAusAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
inv-au-postcode: Australia postal code shall be 4 digits
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... isPrimary S0..1booleanAddress Is Primary Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn
...... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
...... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
...... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
...... line SΣ1..2stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
Max Length: 60
...... district Σ0..1stringDistrict name (aka county)
Example General: Madison
...... state SΣ0..1stringSub-unit of country (abbreviations ok)
Max Length: 20
...... postalCode SΣ0..1stringPostal code for area
Example General: 9132
Max Length: 10
...... country SΣ0..1stringUse a 2 digit ISO 3166 country code
Binding: Iso3166-1-2 (required)
...... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
..... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: Location Type (Physical) - AU Extended (preferred)
..... position 0..1BackboneElementThe absolute geographic location
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... longitude 1..1decimalLongitude with WGS84 datum
...... latitude 1..1decimalLatitude with WGS84 datum
...... altitude 0..1decimalAltitude with WGS84 datum
..... managingOrganization Σ0..1Reference(Organization)Organization responsible for provisioning and upkeep
..... partOf 0..1Reference(Location)Another Location this one is physically a part of
..... hoursOfOperation 0..*BackboneElementWhat days/times during a week is this location usually open
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


...... allDay 0..1booleanThe Location is open all day
...... openingTime 0..1timeTime that the Location opens
...... closingTime 0..1timeTime that the Location closes
..... availabilityExceptions 0..1stringDescription of availability exceptions
..... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier 0..*Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumberBusiness Identifiers that are specific to a role/location
Slice: Unordered, Closed by pattern:type
.... identifier:identifierAUMedicare S0..1AUMedicareProviderNumberMedicare Provider Number
... active SΣ1..1booleanWhether this practitioner role record is in active use
... period Σ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣ1..1Reference(MR Practitioner Contact)Contained resource reference to an external health professional (contact).
... organization SΣ0..1Reference(MR Organisation)Optional reference to an external service provider (account).
... code SΣ1..1CodeableConceptProvider category
Binding: Practitioner Role . (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..1CodingCoded practitioner role
.... text Σ1..1stringProvider category description
... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: Clinical Specialty . (preferred)
... location SΣ0..1Reference(MR 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..*ContactPointContact details that are specific to the role/location/service
Slice: Unordered, Closed by value:use, value:system
.... telecom:workPhone SΣ0..1ContactPointWork Phone. The number should be of maximum 20 digits length
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ1..1stringThe actual contact point details
Max Length: 20
..... use ?!Σ1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: work
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:fax SΣ0..1ContactPointFax. The number should be of maximum 20 digits length
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: fax
..... value SΣ1..1stringThe actual contact point details
Max Length: 20
..... use ?!Σ1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: work
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:mobile SΣ0..1ContactPointMobile. The number should be of maximum 20 digits length
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ1..1stringThe actual contact point details
Max Length: 20
..... use ?!Σ1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: mobile
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:pager SΣ0..1ContactPointPager. The number should be of maximum 20 digits length
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: pager
..... value SΣ1..1stringThe actual contact point details
Max Length: 20
..... use ?!Σ1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: work
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:email SΣ0..1ContactPointEmail
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
..... value SΣ1..1stringThe actual contact point details
..... use ?!Σ1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: work
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... timeZone 0..1CodeableConceptAU time zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
..... value 0..1timePrimitive value for time
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... timeZone 0..1CodeableConceptAU time zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
..... value 0..1timePrimitive value for time
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
​.. PractitionerRole 0..*AUBasePractitionerRoleA practitioner in a healthcare role in an Australian healthcare context
​... meta Σ0..1MetaMetadata about the resource
​.... lastUpdated Σ0..1instantWhen the resource version last changed
​.... profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
​... contained:practitioner 0..1MRPractitionerContactPractitioner resource representing an external health professional (contact)
​... contained:location 0..1MRLocationLocation resource representing an external health professional's location (address)
​.... meta Σ0..1MetaMetadata about the resource
​..... profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
​.... status ?!Σ1..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

​.... address C1..1MRAddress, MRAusAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
inv-au-postcode: Australia postal code shall be 4 digits
​..... isPrimary 0..1booleanAddress Is Primary Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn
​..... line Σ1..2stringStreet 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..1stringName of city, town etc.
Max Length: 60
​..... state Σ0..1stringSub-unit of country (abbreviations ok)
Max Length: 20
​..... postalCode Σ0..1stringPostal code for area
Max Length: 10
​..... country Σ0..1stringUse a 2 digit ISO 3166 country code
Binding: Iso3166-1-2 (required)
​... active Σ1..1booleanWhether this practitioner role record is in active use
​... practitioner Σ1..1Reference(MR Practitioner Contact)Contained resource reference to an external health professional (contact).
​... organization Σ0..1Reference(MR Organisation)Optional reference to an external service provider (account).
​... code Σ1..1CodeableConceptProvider category
Binding: Practitioner Role . (extensible)
​... location Σ0..1Reference(MR Location)Contained resource reference to external health professional's location (address)
​... telecom:workPhone Σ0..1ContactPointWork Phone. The number should be of maximum 20 digits length
​.... value Σ1..1stringThe actual contact point details
Max Length: 20
​... telecom:fax Σ0..1ContactPointFax. The number should be of maximum 20 digits length
​.... value Σ1..1stringThe actual contact point details
Max Length: 20
​... telecom:mobile Σ0..1ContactPointMobile. The number should be of maximum 20 digits length
​.... value Σ1..1stringThe actual contact point details
Max Length: 20
​... telecom:pager Σ0..1ContactPointPager. The number should be of maximum 20 digits length
​.... value Σ1..1stringThe actual contact point details
Max Length: 20
​... telecom:email Σ0..1ContactPointEmail
​.... value Σ1..1stringThe actual contact point details

doco 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:

  • The element PractitionerRole.contained is sliced based on the value of type:$this (Closed)
  • The element PractitionerRole.identifier is sliced based on the value of pattern:type (Closed)
  • The element PractitionerRole.telecom is sliced based on the values of value:use, value:system (Closed)

Differential View

This structure is derived from AUBasePractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
​.. PractitionerRole AUBasePractitionerRole
​... meta
​.... lastUpdated S0..1instantWhen the resource version last changed
​.... profile S1..*canonical(StructureDefinition)Profiles this resource claims to conform to
​... Slices for contained 0..*ResourceContained, inline Resources
Slice: Unordered, Closed by type:$this
​.... contained:practitioner S0..1MRPractitionerContactPractitioner resource representing an external health professional (contact)
​.... contained:location S0..1MRLocationLocation resource representing an external health professional's location (address)
​..... address
​...... line 1..2stringStreet name, number, direction & P.O. Box etc.
​... Slices for identifier 0..*Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumberBusiness Identifiers that are specific to a role/location
Slice: Unordered, Closed by pattern:type
​.... identifier:identifierAUMedicare S0..1AUMedicareProviderNumberMedicare Provider Number
​... practitioner S1..1Reference(MR Practitioner Contact)Contained resource reference to an external health professional (contact).
​... organization S0..1Reference(MR Organisation)Optional reference to an external service provider (account).
​... code S1..1CodeableConceptProvider category
Binding: Practitioner Role . (extensible)
​.... coding 0..1CodingCoded practitioner role
​.... text 1..1stringProvider category description
​... location S0..1Reference(MR Location)Contained resource reference to external health professional's location (address)
​... Slices for telecom 0..*ContactPointContact details that are specific to the role/location/service
Slice: Unordered, Closed by value:use, value:system
​.... telecom:workPhone S0..1ContactPointWork Phone. The number should be of maximum 20 digits length
​..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
​..... value S1..1stringThe actual contact point details
Max Length: 20
​..... use 1..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: work
​.... telecom:fax S0..1ContactPointFax. The number should be of maximum 20 digits length
​..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: fax
​..... value S1..1stringThe actual contact point details
Max Length: 20
​..... use 1..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: work
​.... telecom:mobile S0..1ContactPointMobile. The number should be of maximum 20 digits length
​..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
​..... value S1..1stringThe actual contact point details
Max Length: 20
​..... use 1..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: mobile
​.... telecom:pager S0..1ContactPointPager. The number should be of maximum 20 digits length
​..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: pager
​..... value S1..1stringThe actual contact point details
Max Length: 20
​..... use 1..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: work
​.... telecom:email S0..1ContactPointEmail
​..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: email
​..... value S1..1stringThe actual contact point details
​..... use 1..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: work

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*AUBasePractitionerRoleA practitioner in a healthcare role in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile SΣ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... Slices for contained 0..*ResourceContained, inline Resources
Slice: Unordered, Closed by type:$this
.... contained:practitioner S0..1MRPractitionerContactPractitioner resource representing an external health professional (contact)
.... contained:location S0..1MRLocationLocation resource representing an external health professional's location (address)
..... id Σ0..1idLogical id of this artifact
..... meta Σ0..1MetaMetadata about the resource
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... versionId Σ0..1idVersion specific identifier
...... lastUpdated Σ0..1instantWhen the resource version last changed
...... source Σ0..1uriIdentifies where the resource comes from
...... profile SΣ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
...... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
..... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
..... text 0..1NarrativeText summary of the resource, for human interpretation
..... contained 0..*ResourceContained, inline Resources
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
..... identifier 0..*Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumberUnique code or number identifying the location to its users
..... status ?!SΣ1..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

..... operationalStatus Σ0..1CodingThe 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..1stringName of the location as used by humans
..... alias 0..*stringA list of alternate names that the location is known as, or was known as, in the past
..... description Σ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
..... mode Σ0..1codeinstance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

..... type Σ0..*CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
..... telecom 0..*ContactPointContact details of the location
..... address SC1..1MRAddress, MRAusAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
inv-au-postcode: Australia postal code shall be 4 digits
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... isPrimary S0..1booleanAddress Is Primary Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn
...... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
...... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
...... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
...... line SΣ1..2stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
Max Length: 60
...... district Σ0..1stringDistrict name (aka county)
Example General: Madison
...... state SΣ0..1stringSub-unit of country (abbreviations ok)
Max Length: 20
...... postalCode SΣ0..1stringPostal code for area
Example General: 9132
Max Length: 10
...... country SΣ0..1stringUse a 2 digit ISO 3166 country code
Binding: Iso3166-1-2 (required)
...... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
..... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: Location Type (Physical) - AU Extended (preferred)
..... position 0..1BackboneElementThe absolute geographic location
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... longitude 1..1decimalLongitude with WGS84 datum
...... latitude 1..1decimalLatitude with WGS84 datum
...... altitude 0..1decimalAltitude with WGS84 datum
..... managingOrganization Σ0..1Reference(Organization)Organization responsible for provisioning and upkeep
..... partOf 0..1Reference(Location)Another Location this one is physically a part of
..... hoursOfOperation 0..*BackboneElementWhat days/times during a week is this location usually open
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


...... allDay 0..1booleanThe Location is open all day
...... openingTime 0..1timeTime that the Location opens
...... closingTime 0..1timeTime that the Location closes
..... availabilityExceptions 0..1stringDescription of availability exceptions
..... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier 0..*Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumberBusiness Identifiers that are specific to a role/location
Slice: Unordered, Closed by pattern:type
.... identifier:identifierAUMedicare S0..1AUMedicareProviderNumberMedicare Provider Number
... active SΣ1..1booleanWhether this practitioner role record is in active use
... period Σ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣ1..1Reference(MR Practitioner Contact)Contained resource reference to an external health professional (contact).
... organization SΣ0..1Reference(MR Organisation)Optional reference to an external service provider (account).
... code SΣ1..1CodeableConceptProvider category
Binding: Practitioner Role . (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..1CodingCoded practitioner role
.... text Σ1..1stringProvider category description
... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: Clinical Specialty . (preferred)
... location SΣ0..1Reference(MR 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..*ContactPointContact details that are specific to the role/location/service
Slice: Unordered, Closed by value:use, value:system
.... telecom:workPhone SΣ0..1ContactPointWork Phone. The number should be of maximum 20 digits length
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ1..1stringThe actual contact point details
Max Length: 20
..... use ?!Σ1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: work
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:fax SΣ0..1ContactPointFax. The number should be of maximum 20 digits length
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: fax
..... value SΣ1..1stringThe actual contact point details
Max Length: 20
..... use ?!Σ1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: work
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:mobile SΣ0..1ContactPointMobile. The number should be of maximum 20 digits length
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ1..1stringThe actual contact point details
Max Length: 20
..... use ?!Σ1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: mobile
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:pager SΣ0..1ContactPointPager. The number should be of maximum 20 digits length
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: pager
..... value SΣ1..1stringThe actual contact point details
Max Length: 20
..... use ?!Σ1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: work
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:email SΣ0..1ContactPointEmail
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
..... value SΣ1..1stringThe actual contact point details
..... use ?!Σ1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: work
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... timeZone 0..1CodeableConceptAU time zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
..... value 0..1timePrimitive value for time
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... timeZone 0..1CodeableConceptAU time zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
..... value 0..1timePrimitive value for time
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / CodeURI
PractitionerRole.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
PractitionerRole.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
PractitionerRole.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
PractitionerRole.contained:location.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
PractitionerRole.contained:location.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
PractitionerRole.contained:location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
PractitionerRole.contained:location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
PractitionerRole.contained:location.operationalStatuspreferredHl7VSBedStatus
http://terminology.hl7.org/ValueSet/v2-0116
PractitionerRole.contained:location.moderequiredLocationMode
http://hl7.org/fhir/ValueSet/location-mode|4.0.1
from the FHIR Standard
PractitionerRole.contained:location.typeextensibleServiceDeliveryLocationRoleTypeAUExtended
http://terminology.hl7.org.au/ValueSet/v3-ServiceDeliveryLocationRoleType-extended
PractitionerRole.contained:location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
PractitionerRole.contained:location.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
PractitionerRole.contained:location.address.countryrequiredIso3166-1-2
http://hl7.org/fhir/ValueSet/iso3166-1-2
from the FHIR Standard
PractitionerRole.contained:location.physicalTypepreferredLocationPhysicalTypeAUExtended
http://terminology.hl7.org.au/ValueSet/location-physical-type-extended
PractitionerRole.contained:location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard
PractitionerRole.codeextensiblePractitionerRole .
https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
PractitionerRole.specialtypreferredClinicalSpecialty .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1
PractitionerRole.telecom:workPhone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
PractitionerRole.telecom:workPhone.userequiredFixed Value: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
PractitionerRole.telecom:fax.systemrequiredFixed Value: fax
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
PractitionerRole.telecom:fax.userequiredFixed Value: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
PractitionerRole.telecom:mobile.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
PractitionerRole.telecom:mobile.userequiredFixed Value: mobile
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
PractitionerRole.telecom:pager.systemrequiredFixed Value: pager
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
PractitionerRole.telecom:pager.userequiredFixed Value: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
PractitionerRole.telecom:email.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
PractitionerRole.telecom:email.userequiredFixed Value: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerRoleIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerRoleA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-au-postcodeerrorPractitionerRole.contained:location.addressAustralia postal code shall be 4 digits
: (country.exists() and country.matches('^AU$').not()) or postalCode.matches('^[0-9]{4}$')