Provincial Provider Registry (PPR) HL7 FHIR® Implementation Guide

Terminology

Various coded values which are used to describe clinical concepts within health records as well as codes used within messages to meet the structural requirements of interfaces.

*Please note that these are Code System and/or Value set created by Ontario Health

**Please note that access and use of SNOMED CT subsets on Canada Health Infoway Terminology Gateway requires an Infoway account with acceptance of the SNOMED CT license agreements

Value Sets defined by this implementation guide:

Value Set	Description	Profile	Binding Strength
AddressType`*`	Codes supported by Ontario Health differentiating mailing from physical addresses.	Location (Response): Location.address.type, Location (PractitionerRoleResponse): Location.address.type, Practitioner (Response): Practitioner.address.type	Required
AddressUse`*`	Codes supported by Ontario Health indicating how the patient and provider address is used.	Location (Response): Location.address.use, Location (PractitionerRoleResponse): Location.address.use, Practitioner (Response): Practitioner.address.use	Required
AdministrativeGender	Administrative genders for Practitioners supported by the Ontario Health PCR and PPR interface.	Practitioner (MatchRequest): Practitioner.gender, Practitioner (Response): Practitioner.gender	Required
BundleEntryMode	Why this entry is in the result set - whether it's included as a match or because of an _include requirement.	Bundle (LocationMatchRequest): Bundle.entry.search.mode, Bundle (PractitionerMatch): Bundle.entry.search.mode	Required
BundleType	Indicates the purpose of this bundle - how it was intended to be used.	Bundle (LocationMatchRequest): Bundle.type, Bundle (PractitionerMatch): Bundle.type	Required
ContactOrganizations`*`	Codes supported by Ontario Health differentiating types of contact point systems for organizations.	Location (EMPIMatchRequest): Location.telecom.system, Location (Response): Location.telecom.system,	Required
ContactPointUse	Identifies the purpose for the contact point.	Location (PractitionerRoleResponse):Location.telecom.use, Location (Response): Location.telecom.use, Practitioner (Response): Practitioner.telecom.use,	Required
ContactPractitioners`*`	Codes supported by Ontario Health differentiating types of contact point systems for practitioners.	Location (PractitionerRoleResponse): Location.telecom.system, Practitioner (Response): Practitioner.telecom.system	Required
CountryCodes`*`	3-character ISO country codes for use in addresses by the Ontario Health PPR and PCR interface.	Location (EMPIMatchRequest): Location.address.country, Location (PractitionerRoleResponse): Location.address.country, Location (Response): Location.address.country, Practitioner (MatchRequest): Practitioner.address.country, Practitioner (Response): Practitioner.address.country	Required
HealthCareProviderRoleType`*`	A role type that is used to categorize an entity that delivers health care in an expected and professional manner to an entity in need of health care services, i.e. provider's profession. Examples: Registered Nurse, Chiropractor, Physician.	PractitionerRole (MatchRequest): PractitionerRole.code, PractitionerRole (MatchRequest): PractitionerRole.code.coding.code, PractitionerRole (Response): PractitionerRole.code	Required
Language`*`	Languages understood or supported by Ontario clients, practitioners and organizations. This value set represents the subset of all ISO living languages as of April 22, 2020.	Location (Response): Location.alias.extension:human-language.valueCoding.code, Location (Response): Location.extension:location-language.valueCoding.code, Location (Response): Location.contained.otherName.extension:human-language.valueCoding.code, Practitioner (MatchRequest): Practitioner.communication, Practitioner (MatchRequest): Practitioner.communication.coding.code, Practitioner (Response): Practitioner.communication, PractitionerRole (MatchRequest): PractitionerRole.language	Extensible
IdentifierType`*`	Codes supported by Ontario Health differentiating types of identifiers.	Location (Response): Location.identifier.type, Practitioner (Response): Practitioner.identifier.type, PractitionerRole (Response): PractitionerRole.identifier.type PractitionerRole (Response): PractitionerRole.identifier.type.coding.code	Extensible
IdentifierUse	Identifies the purpose for this identifier, if known.	Location (Response): Location.identifier.use, Practitioner (Response): Practitioner.identifier.use, PractitionerRole (MatchRequest): PractitionerRole.practitioner.identifier.use PractitionerRole (Response): PractitionerRole.identifier.use	Required
IssueSeverity	Indicates whether the issue indicates a variation from successful processing.	OperationOutcome: OperationOutcome.issue.severity	Required
IssueType	Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.	OperationOutcome: OperationOutcome.issue.code	Required
LHINCodes`*`	Ontario Local Health Integration Network (LHIN) code as a catchment area of provider.	Location (EMPIMatchRequest): Location.extension:LHIN-code.valueCoding.code, Location (PractitionerRoleResponse): Location.extension:LHIN-code.valueCoding.code, Location (Response): Location.extension:LHIN-code.valueCoding.code, Practitioner (Response): Practitioner.address.extension:LHIN-code.valueCoding.code	Required
LicenseClassificationCode`*`	A code to identify a particular class of licence for a health care practitioner. Licence classes are defined by the governing body that issues the licence. Note: Not all health professions have classes.	PractitionerRole (Response): PractitionerRole.code.extension:license-classification-code.valueCoding.code	Preferred
LocationOperationalStatusReason`*`	Reason of Location operational status	Location (Response): Location.status.extension:status-reason.valueCoding.code	Preferred
LocationStatus	Indicates whether the location is still in use.	Location (Response): Location.status	Required
MasterDataExceptionCode`*`	Error and warning codes returned by the back-end Ontario Health Provincial Provider Registry service interface.	OperationOutcome: OperationOutcome.issue.details.coding OperationOutcome: OperationOutcome.issue.details.coding.code	Extensible
NamePartQualifier	A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type	Practitioner (Response): Practitioner.name.suffix.extension:EN-qualifier.valueCode	Required
NameUse`*`	Codes supported by Ontario Health differentiating types of name uses.	Practitioner (Response): Practitioner.name.use	Required
NarrativeStatus	The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.	PractitionerRole(MatchRequest): PractitionerRole.text.status	Required
OperationalStatus`*`	Organization operational status as received from the data source (e.g. MOH, CNO, CPSO, etc).	Location (PractitionerRoleResponse): Location.status Location (Response): Location.status	Required
OrganizationAlias`*`	A list of alternate names that the organization is known as, or was known as in the past.	Location (Response): Location.contained.otherName.extension:organization-name-type.valueCoding.code Location (Response): Location.alias.extension:organization-name-type.valueCoding.code Organization.alias.extension:organization-name-type.valueCoding.code	Required
ProviderAddressPurpose`*`	Type of provider's practice address or site address.	Location (PractitionerRoleResponse): Location.address.extension:address-purpose.valueCoding.code Location (Response): Location.extension:address-purpose.valueCode Practitioner (Response): Practitioner.extension:address-purpose.valueCode	Required
ProviderOrganizationRoleType`*`	Type of provider organization role.	Location (EMPIMatchRequest): Location.type.coding.code, Location (EMPIMatchRequest): Location.extension:organization-type.valueCoding.code, Location (EMPIMatchRequest): Location.extension:registration-subclass.valueCoding.code, Location (Response): Location.coding.code, Location (Response): Location.extension:organization-type.valueCoding.code, Location (Response): Location.extension:registration-subclass.valueCoding.code Location (Response): Location.type.coding.code	Preferred
ProviderRoleAffiliationType`*`	A unique code to identify the type of affiliation between the healthcare provider and the affiliated organization.	Location (Response): Location.extension:location-affiliation:extension:type.valueCodeableConcept, PractitionerRole (Response): PractitionerRole.extension:location-affiliation:extension:type.valueCodeableConcept	Required
ProviderRoleClassType`*`	Type of provider role class.	PractitionerRole (Response): PractitionerRole.code.coding.code, PractitionerRole (Response): PractitionerRole.extension:practitionerRole-classification.valueCoding.code, PractitionerRole (Response): PractitionerRole.specialty.extension:practitionerRole-classification.valueCoding.code	Required
ProviderRoleStatusType`*`	Status of provider role as received from the data source (e.g. MOH, CNO, CPSO, etc). Used as one of the parameters to define active/inactive role status of a provider (see RoleStatus).	PractitionerRole (Response): PractitionerRole.extension:practitionerRole-status.valueCode	Required
Province-StateCodes`*`	Codes for provinces, states and territories supported by the Ontario Health PCR and PPR interface.	Practitioner (MatchRequest): Practitioner.address.state, Practitioner (Response): Practitioner.address.state, Location (EMPIMatchRequest): Location.address.state, Location (PractitionerRoleResponse): Location.address.state Location (Response): Location.address.state	Extensible
QualifiedCredentialRoleType`*`	A code for the degree or educational rank that the credential specifies.	Practitioner (Response): Practitioner.qualification.code, Practitioner (Response): Practitioner.qualification.extension:qualification-level.valueCoding.code	Required
QualifiedExpertiseRoleType`**`	Qualified expertise role type, i.e. provider's specialty.	PractitionerRole (MatchRequest): PractitionerRole.specialty, PractitionerRole (Response): PractitionerRole.specialty, PractitionerRole (Response): PractitionerRole.specialty.coding.code	Required
RestrictionToPracticeType`*`	Type of restriction imposed by a governing body against the practitioner's license.	PractitionerRole (Response): PractitionerRole.extension:practitioner-restriction.extension:type-of-limitation.valueCode	Required
SecurityLabels	A single value set for all security labels defined by FHIR.	Location (PractitionerRoleResponse): Location.meta.security, Location (Response): Location.meta.security, Practitioner (Response): Practitioner.meta.security PractitionerRole (Response): PractitionerRole.meta.security,	Extensible