Profiles & Operations Index > Profile: PractitionerRole (Practitioner Response)

Profile: PractitionerRole (Practitioner Response)

Canonical URL:http://ontariohealth.ca/fhir/StructureDefinition/ca-on-phsd-practitioner-response-profile-PractitionerRole

Simplifier project page: PHSD PractitionerRole Response

Derived from: PractitionerRole (R4)

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work

Differential View

idS Σ1..1string
id0..1string
extensionC0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
id0..1string
extensionC0..*Extension
systemS Σ1..1uriAuto Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
practitioner-restrictionS C0..*Extension(Complex)
practitionerRole-statusS C0..1Extension(code)
practitionerRole-practicingS C0..1Extension(boolean)
modifierExtension?! C0..*Extension
id0..1string
extensionC0..*Extension
useS Σ ?!1..1codeBindingAuto Value
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriAuto Value
versionΣ0..1string
codeS Σ1..1codeAuto Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemS Σ1..1uriAuto Value
valueS Σ1..1string
periodΣ0..1Period
assignerΣ0..1Reference(Organization)
activeΣ0..1boolean
id0..1string
extensionC0..*Extension
startS Σ C0..1dateTime
endΣ C0..1dateTime
id0..1string
extensionC0..*Extension
referenceS Σ C0..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
organizationΣ0..1Reference(OrganizationResponse)
id0..1string
practitionerRole-classificationS C0..*Extension(CodeableConcept)
license-classification-codeS C0..1Extension(Coding)
id0..1string
extensionC0..*Extension
systemS Σ1..1uriAuto Value
versionΣ0..1string
codeS Σ1..1codeBinding
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
practitionerRole-speciality-periodS C0..*Extension(Period)
practitionerRole-classificationS C1..1Extension(CodeableConcept)
id0..1string
extensionC0..*Extension
systemS Σ1..1uri
versionΣ0..1string
codeS Σ1..1codeBinding
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionC0..*Extension
referenceS Σ C0..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
healthcareServiceS0..*Reference(HealthcareService)
telecomΣ0..*ContactPoint
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
daysOfWeek0..*codeBinding
allDay0..1boolean
availableStartTime0..1time
availableEndTime0..1time
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
description1..1string
during0..1Period
availabilityExceptions0..1string
endpoint0..*Reference(Endpoint)

Hybrid View

idS Σ1..1string
id0..1string
extensionC0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
id0..1string
extensionC0..*Extension
systemS Σ1..1uriAuto Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
practitioner-restrictionS C0..*Extension(Complex)
practitionerRole-statusS C0..1Extension(code)
practitionerRole-practicingS C0..1Extension(boolean)
modifierExtension?! C0..*Extension
id0..1string
extensionC0..*Extension
useS Σ ?!1..1codeBindingAuto Value
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriAuto Value
versionΣ0..1string
codeS Σ1..1codeAuto Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemS Σ1..1uriAuto Value
valueS Σ1..1string
periodΣ0..1Period
assignerΣ0..1Reference(Organization)
activeΣ0..1boolean
id0..1string
extensionC0..*Extension
startS Σ C0..1dateTime
endΣ C0..1dateTime
id0..1string
extensionC0..*Extension
referenceS Σ C0..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
organizationΣ0..1Reference(OrganizationResponse)
id0..1string
practitionerRole-classificationS C0..*Extension(CodeableConcept)
license-classification-codeS C0..1Extension(Coding)
id0..1string
extensionC0..*Extension
systemS Σ1..1uriAuto Value
versionΣ0..1string
codeS Σ1..1codeBinding
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
practitionerRole-speciality-periodS C0..*Extension(Period)
practitionerRole-classificationS C1..1Extension(CodeableConcept)
id0..1string
extensionC0..*Extension
systemS Σ1..1uri
versionΣ0..1string
codeS Σ1..1codeBinding
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionC0..*Extension
referenceS Σ C0..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
healthcareServiceS0..*Reference(HealthcareService)
telecomΣ0..*ContactPoint
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
daysOfWeek0..*codeBinding
allDay0..1boolean
availableStartTime0..1time
availableEndTime0..1time
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
description1..1string
during0..1Period
availabilityExceptions0..1string
endpoint0..*Reference(Endpoint)

Snapshot View

idS Σ1..1string
id0..1string
extensionC0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
id0..1string
extensionC0..*Extension
systemS Σ1..1uriAuto Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
practitioner-restrictionS C0..*Extension(Complex)
practitionerRole-statusS C0..1Extension(code)
practitionerRole-practicingS C0..1Extension(boolean)
modifierExtension?! C0..*Extension
id0..1string
extensionC0..*Extension
useS Σ ?!1..1codeBindingAuto Value
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriAuto Value
versionΣ0..1string
codeS Σ1..1codeAuto Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemS Σ1..1uriAuto Value
valueS Σ1..1string
periodΣ0..1Period
assignerΣ0..1Reference(Organization)
activeΣ0..1boolean
id0..1string
extensionC0..*Extension
startS Σ C0..1dateTime
endΣ C0..1dateTime
id0..1string
extensionC0..*Extension
referenceS Σ C0..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
organizationΣ0..1Reference(OrganizationResponse)
id0..1string
practitionerRole-classificationS C0..*Extension(CodeableConcept)
license-classification-codeS C0..1Extension(Coding)
id0..1string
extensionC0..*Extension
systemS Σ1..1uriAuto Value
versionΣ0..1string
codeS Σ1..1codeBinding
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
practitionerRole-speciality-periodS C0..*Extension(Period)
practitionerRole-classificationS C1..1Extension(CodeableConcept)
id0..1string
extensionC0..*Extension
systemS Σ1..1uri
versionΣ0..1string
codeS Σ1..1codeBinding
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionC0..*Extension
referenceS Σ C0..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
healthcareServiceS0..*Reference(HealthcareService)
telecomΣ0..*ContactPoint
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
daysOfWeek0..*codeBinding
allDay0..1boolean
availableStartTime0..1time
availableEndTime0..1time
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
description1..1string
during0..1Period
availabilityExceptions0..1string
endpoint0..*Reference(Endpoint)

Table View

PractitionerRole..
PractitionerRole.id1..
PractitionerRole.meta1..
PractitionerRole.meta.profile1..
PractitionerRole.meta.security1..1
PractitionerRole.meta.security.system1..
PractitionerRole.meta.security.code1..
PractitionerRole.meta.security.display1..
PractitionerRole.extension:practitioner-restrictionExtension..
PractitionerRole.extension:practitionerRole-statusExtension..1
PractitionerRole.extension:practitionerRole-practicingExtension..1
PractitionerRole.identifier1..
PractitionerRole.identifier:identifier-UPI1..
PractitionerRole.identifier:identifier-UPI.use1..
PractitionerRole.identifier:identifier-UPI.type1..
PractitionerRole.identifier:identifier-UPI.type.coding1..1
PractitionerRole.identifier:identifier-UPI.type.coding.system1..
PractitionerRole.identifier:identifier-UPI.type.coding.code1..
PractitionerRole.identifier:identifier-UPI.system1..
PractitionerRole.identifier:identifier-UPI.value1..
PractitionerRole.period..
PractitionerRole.period.start..
PractitionerRole.practitionerReference(PractitionerResponse)..
PractitionerRole.practitioner.reference..
PractitionerRole.organizationReference(OrganizationResponse)..
PractitionerRole.code1..
PractitionerRole.code.extension:practitionerRole-classificationExtension..
PractitionerRole.code.extension:license-classification-codeExtension..1
PractitionerRole.code.coding1..1
PractitionerRole.code.coding.system1..
PractitionerRole.code.coding.code1..
PractitionerRole.code.coding.display..
PractitionerRole.specialty..
PractitionerRole.specialty.extension1..
PractitionerRole.specialty.extension:practitionerRole-speciality-periodExtension..
PractitionerRole.specialty.extension:practitionerRole-classificationExtension1..1
PractitionerRole.specialty.coding1..1
PractitionerRole.specialty.coding.system1..
PractitionerRole.specialty.coding.code1..
PractitionerRole.specialty.coding.display..
PractitionerRole.locationReference(LocationResponse)..
PractitionerRole.location.reference..
PractitionerRole.healthcareService..

JSON View

{
"resourceType": "StructureDefinition",
"id": "56be103b-3d81-45ea-8f59-96c7913e0002",
"meta": {
"versionId": "2",
"lastUpdated": "2025-02-21T15:01:22.2572371+00:00"
},
"text": {
"status": "empty",
--- We have skipped the narrative for better readability of the resource ---
},
"url": "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-phsd-practitioner-response-profile-PractitionerRole",
"version": "1.0.0",
"name": "PractitionerRoleResponse",
"title": "PHSD PractitionerRole Response",
"status": "draft",
"date": "2024-03-06T15:47:38.7603239+00:00",
"description": "Defines the PractitionerRole resource in a Practitioner Search response from PHSD",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "servd",
"uri": "http://www.omg.org/spec/ServD/1.0/",
"name": "ServD"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "PractitionerRole",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"derivation": "constraint",
"element": [
{
"id": "PractitionerRole",
"path": "PractitionerRole",
"mustSupport": true
},
{
"id": "PractitionerRole.id",
"path": "PractitionerRole.id",
"definition": "The logical id of the resource, as used in the URL for the resource. The member record number in PPR.",
"min": 1,
"example": [
{
"label": "Example of member record number",
"valueString": "123456"
}
],
"mustSupport": true
},
{
"id": "PractitionerRole.meta",
"path": "PractitionerRole.meta",
"min": 1,
"mustSupport": true
},
{
"id": "PractitionerRole.meta.profile",
"path": "PractitionerRole.meta.profile",
"min": 1,
"mustSupport": true
},
{
"id": "PractitionerRole.meta.security",
"path": "PractitionerRole.meta.security",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "PractitionerRole.meta.security.system",
"path": "PractitionerRole.meta.security.system",
"min": 1,
"fixedUri": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
"mustSupport": true
},
{
"id": "PractitionerRole.meta.security.code",
"path": "PractitionerRole.meta.security.code",
"short": "N|R",
"min": 1,
"mustSupport": true
},
{
"id": "PractitionerRole.meta.security.display",
"path": "PractitionerRole.meta.security.display",
"short": "normal|restricted",
"min": 1,
"mustSupport": true
},
{
"id": "PractitionerRole.extension:practitioner-restriction",
"path": "PractitionerRole.extension",
"sliceName": "practitioner-restriction",
"type": [
{
"code": "Extension",
"profile": [
"http://ontariohealth.ca/fhir/StructureDefinition/ca-on-phsd-ext-practitioner-restriction"
]
}
]
},
{
"id": "PractitionerRole.extension:practitionerRole-status",
"path": "PractitionerRole.extension",
"sliceName": "practitionerRole-status",
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://ontariohealth.ca/fhir/StructureDefinition/ca-on-phsd-ext-practitionerRole-status"
]
}
]
},
{
"id": "PractitionerRole.extension:practitionerRole-practicing",
"path": "PractitionerRole.extension",
"sliceName": "practitionerRole-practicing",
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://ontariohealth.ca/fhir/StructureDefinition/ca-on-phsd-ext-practitionerRole-practicing"
]
}
]
},
{
"id": "PractitionerRole.identifier",
"path": "PractitionerRole.identifier",
"slicing": {
{
"type": "value",
"path": "use"
},
{
"type": "value",
"path": "type.coding.code"
}
],
"rules": "open"
},
"min": 1,
"mustSupport": true
},
{
"id": "PractitionerRole.identifier:identifier-UPI",
"path": "PractitionerRole.identifier",
"sliceName": "identifier-UPI",
"min": 1
},
{
"id": "PractitionerRole.identifier:identifier-UPI.use",
"path": "PractitionerRole.identifier.use",
"min": 1,
"fixedCode": "official",
"mustSupport": true
},
{
"id": "PractitionerRole.identifier:identifier-UPI.type",
"path": "PractitionerRole.identifier.type",
"min": 1,
"mustSupport": true
},
{
"id": "PractitionerRole.identifier:identifier-UPI.type.coding",
"path": "PractitionerRole.identifier.type.coding",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "PractitionerRole.identifier:identifier-UPI.type.coding.system",
"path": "PractitionerRole.identifier.type.coding.system",
"min": 1,
"fixedUri": "http://terminology.hl7.org/CodeSystem/v2-0203",
"mustSupport": true
},
{
"id": "PractitionerRole.identifier:identifier-UPI.type.coding.code",
"path": "PractitionerRole.identifier.type.coding.code",
"min": 1,
"fixedCode": "PRN",
"mustSupport": true
},
{
"id": "PractitionerRole.identifier:identifier-UPI.system",
"path": "PractitionerRole.identifier.system",
"min": 1,
"fixedUri": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-on-provider-upi",
"mustSupport": true
},
{
"id": "PractitionerRole.identifier:identifier-UPI.value",
"path": "PractitionerRole.identifier.value",
"min": 1,
"mustSupport": true
},
{
"id": "PractitionerRole.period",
"path": "PractitionerRole.period",
"mustSupport": true
},
{
"id": "PractitionerRole.period.start",
"path": "PractitionerRole.period.start",
"mustSupport": true
},
{
"id": "PractitionerRole.practitioner",
"path": "PractitionerRole.practitioner",
"type": [
{
"code": "Reference",
"http://ontariohealth.ca/fhir/StructureDefinition/ca-on-phsd-practitioner-response-profile-Practitioner"
]
}
],
"mustSupport": true
},
{
"id": "PractitionerRole.practitioner.reference",
"path": "PractitionerRole.practitioner.reference",
"mustSupport": true
},
{
"id": "PractitionerRole.organization",
"path": "PractitionerRole.organization",
"type": [
{
"code": "Reference",
"http://ontariohealth.ca/fhir/StructureDefinition/ca-on-phsd-organization-response-profile-Organization"
]
}
]
},
{
"id": "PractitionerRole.code",
"path": "PractitionerRole.code",
"min": 1,
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://ontariohealth.ca/fhir/ValueSet/health-care-provider-role-type"
}
},
{
"id": "PractitionerRole.code.extension:practitionerRole-classification",
"path": "PractitionerRole.code.extension",
"sliceName": "practitionerRole-classification",
"type": [
{
"code": "Extension",
"profile": [
"http://ontariohealth.ca/fhir/StructureDefinition/ca-on-phsd-ext-practitionerRole-classification"
]
}
]
},
{
"id": "PractitionerRole.code.extension:license-classification-code",
"path": "PractitionerRole.code.extension",
"sliceName": "license-classification-code",
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://ontariohealth.ca/fhir/StructureDefinition/ca-on-phsd-ext-LicenseClassificationCode"
]
}
]
},
{
"id": "PractitionerRole.code.coding",
"path": "PractitionerRole.code.coding",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "PractitionerRole.code.coding.system",
"path": "PractitionerRole.code.coding.system",
"min": 1,
"fixedUri": "http://ehealthontario.ca/fhir/CodeSystem/ppr-health-care-provider-role-type",
"mustSupport": true
},
{
"id": "PractitionerRole.code.coding.code",
"path": "PractitionerRole.code.coding.code",
"min": 1,
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://ehealthontario.ca/fhir/ValueSet/ppr-healthcare-provider-role-type"
}
},
{
"id": "PractitionerRole.code.coding.display",
"path": "PractitionerRole.code.coding.display",
"mustSupport": true
},
{
"id": "PractitionerRole.specialty",
"path": "PractitionerRole.specialty",
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://ontariohealth.ca/fhir/ValueSet/qualified-expertise-role-type"
}
},
{
"id": "PractitionerRole.specialty.extension",
"path": "PractitionerRole.specialty.extension",
"min": 1
},
{
"id": "PractitionerRole.specialty.extension:practitionerRole-speciality-period",
"path": "PractitionerRole.specialty.extension",
"sliceName": "practitionerRole-speciality-period",
"type": [
{
"code": "Extension",
"profile": [
"http://ontariohealth.ca/fhir/StructureDefinition/ca-on-phsd-ext-practitionerRole-specialty-period"
]
}
]
},
{
"id": "PractitionerRole.specialty.extension:practitionerRole-classification",
"path": "PractitionerRole.specialty.extension",
"sliceName": "practitionerRole-classification",
"min": 1,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://ontariohealth.ca/fhir/StructureDefinition/ca-on-phsd-ext-practitionerRole-classification"
]
}
]
},
{
"id": "PractitionerRole.specialty.coding",
"path": "PractitionerRole.specialty.coding",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "PractitionerRole.specialty.coding.system",
"path": "PractitionerRole.specialty.coding.system",
"min": 1,
"mustSupport": true
},
{
"id": "PractitionerRole.specialty.coding.code",
"path": "PractitionerRole.specialty.coding.code",
"min": 1,
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://ehealthontario.ca/fhir/ValueSet/ppr-qualified-expertise-role-type"
}
},
{
"id": "PractitionerRole.specialty.coding.display",
"path": "PractitionerRole.specialty.coding.display",
"mustSupport": true
},
{
"id": "PractitionerRole.location",
"path": "PractitionerRole.location",
"short": "For PPR future use only",
"type": [
{
"code": "Reference",
"http://ontariohealth.ca/fhir/StructureDefinition/ca-on-phsd-location-response-profile-Location"
]
}
],
"mustSupport": true
},
{
"id": "PractitionerRole.location.reference",
"path": "PractitionerRole.location.reference",
"mustSupport": true
},
{
"id": "PractitionerRole.healthcareService",
"path": "PractitionerRole.healthcareService",
"mustSupport": true
}
]
}
}

Usage

Thi PractitionerRole Resource is returned when submitting a Practitioner Search or Match request.

Notes

.id

  • Definition: Logical id of this artifact
  • used to uniquely identify the resource on this server; may change on other servers

.meta.profile

  • this must be populated with the value http://ontariohealth.ca/fhir/StructureDefinition/ca-on-phsd-practitioner-response-profile-PractitionerRole|1.0.0

.extension (wait-times)

  • if this extension is populated, it represents the wait time information for this practitioner (PractitionerRole.practitioner) at the specified location (PractitionerRole.location)
  • Within the extension, these data will be provided
    • wait time type (WT1 or WT2)
    • wait days
    • wait priority
    • wait access targets (in days)
  • Other elements in the PractitionerRole are also used to capture wait time data such as:
  • PractitionerRole.practitioner.identifier: The healthcare professional name and identifier code for the physician who oversees the procedure.
  • PractitionerRole.practitioner.identifier.type: This data element is used to differentiate whether the provider is a surgeon or dental surgeon. This maps to "HCP Provider Role Type" in MDS. Note that type is not MS in this IG. We'll need to add it.
  • PractitionerRole.organization: The healthcare facility where the patient is registered and where the procedure took place. This maps to "Facility" in wait times MDS.
  • PractitionerRole.location: The healthcare site where the patient receives care. THis maps to "Site" in wait times MDS
  • PractitionerRole.healthcareService.category: A high-level category of the defined procedures. This maps to "Service Area" in MDS. (Note: need further discussion on the value set. Currently we support non clinical categories. Same for "Service Detail 1" and "Service Detail 2")