Ontario eServices | Practitioner

EReferralPractitioner (Practitioner)	I		Practitioner	There are no (further) constraints on this element Element id Practitioner Short description A person with a formal responsibility in the provisioning of healthcare or related services Definition A person who is directly or indirectly involved in the provisioning of healthcare. Data type Practitioner Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() Mappings rim: Entity. Role, or Act v2: PRD (as one example) rim: Role servd: Provider
id	Σ	0..1	string	There are no (further) constraints on this element Element id Practitioner.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	S Σ	1..1	Meta	There are no (further) constraints on this element Element id Practitioner.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
id		0..1	string	There are no (further) constraints on this element Element id Practitioner.meta.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.meta.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
versionId	Σ	0..1	id	There are no (further) constraints on this element Element id Practitioner.meta.versionId Short description Version specific identifier Definition The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. Comments The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. Data type id Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
lastUpdated	Σ	0..1	instant	There are no (further) constraints on this element Element id Practitioner.meta.lastUpdated Short description When the resource version last changed Definition When the resource last changed - e.g. when the version changed. Comments This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. Data type instant Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
source	Σ	0..1	uri	There are no (further) constraints on this element Element id Practitioner.meta.source Short description Identifies where the resource comes from Definition A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. Comments In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
profile	S Σ	1..*	canonical(StructureDefinition)	Element id Practitioner.meta.profile Short description Profiles this resource claims to conform to Definition A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. Comments *`FOR eREFERRAL USAGE: The meta.profile = http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Practitioner\|1.1.0`* It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. Data type canonical(StructureDefinition) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
security	Σ	0..*	CodingBinding	There are no (further) constraints on this element Element id Practitioner.meta.security Short description Security Labels applied to this resource Definition Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. Comments The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Data type Coding Binding Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
tag	Σ	0..*	Coding	There are no (further) constraints on this element Element id Practitioner.meta.tag Short description Tags applied to this resource Definition Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. Comments The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Data type Coding Binding Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". CommonTags (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Practitioner.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id Practitioner.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text		0..1	Narrative	There are no (further) constraints on this element Element id Practitioner.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id Practitioner.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
identifier	S Σ	0..*	Identifier	There are no (further) constraints on this element Element id Practitioner.identifier Short description An identifier for the person as this agent Definition An identifier that applies to this person in this role. Requirements Often, specific identities are assigned for the agent. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier v2: PRD-7 (or XCN.1) rim: ./id servd: ./Identifiers
id		0..1	string	There are no (further) constraints on this element Element id Practitioner.identifier.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.identifier.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id Practitioner.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: N/A rim: Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id Practitioner.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.5 rim: Role.code or implied by context
system	S Σ	1..1	uri	There are no (further) constraints on this element Element id Practitioner.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
value	S Σ	1..1	string	There are no (further) constraints on this element Element id Practitioner.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
period	Σ	0..1	Period	There are no (further) constraints on this element Element id Practitioner.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
assigner	Σ	0..1	Reference(Organization)	There are no (further) constraints on this element Element id Practitioner.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
active	Σ	0..1	boolean	There are no (further) constraints on this element Element id Practitioner.active Short description Whether this practitioner's record is in active use Definition Whether this practitioner's record is in active use. Requirements Need to be able to mark a practitioner record as not to be used because it was created in error. Comments If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role. Meaning when missing This resource is generally assumed to be active if no value is provided for the active element Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.status rim: ./statusCode
name	S Σ	0..1	HumanName	There are no (further) constraints on this element Element id Practitioner.name Short description The name(s) associated with the practitioner Definition The name(s) associated with the practitioner. Requirements The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. Comments The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this: There is more than 1 name Use = usual Period is current to the date of the usage Use = official Other order as decided by internal business rules. Data type HumanName Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XCN Components rim: ./name servd: ./PreferredName (GivenNames, FamilyName, TitleCode)
id		0..1	string	There are no (further) constraints on this element Element id Practitioner.name.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.name.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
use	S Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id Practitioner.name.use Short description usual \| official \| temp \| nickname \| anonymous \| old \| maiden Definition Identifies the purpose for this name. Requirements Allows the appropriate name for a particular context of use to be selected from among a set of names. Comments Applications can assume that a name is current unless it explicitly says that it is temporary or old. Data type code Binding The use of a human name. NameUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XPN.7, but often indicated by which field contains the name rim: unique(./use) servd: ./NamePurpose
text	S Σ	0..1	string	There are no (further) constraints on this element Element id Practitioner.name.text Short description Text representation of the full name Definition Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. Requirements A renderable, unencoded form. Comments Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: implied by XPN.11 rim: ./formatted
family	S Σ	1..1	string	There are no (further) constraints on this element Element id Practitioner.name.family Short description Family name (often called 'Surname') Alternate names surname Definition The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. Comments Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XPN.1/FN.1 rim: ./part[partType = FAM] servd: ./FamilyName
given	S Σ	0..*	string	There are no (further) constraints on this element Element id Practitioner.name.given Short description Given names (not always 'first'). Includes middle names Alternate names first name, middle name Definition Given name. Comments If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XPN.2 + XPN.3 rim: ./part[partType = GIV] servd: ./GivenNames
prefix	Σ	0..*	string	There are no (further) constraints on this element Element id Practitioner.name.prefix Short description Parts that come before the name Definition Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XPN.5 rim: ./part[partType = PFX] servd: ./TitleCode
suffix	Σ	0..*	string	There are no (further) constraints on this element Element id Practitioner.name.suffix Short description Parts that come after the name Definition Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XPN/4 rim: ./part[partType = SFX]
period	Σ	0..1	Period	There are no (further) constraints on this element Element id Practitioner.name.period Short description Time period when name was/is in use Definition Indicates the period of time when this name was valid for the named person. Requirements Allows names to be placed in historical context. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XPN.13 + XPN.14 rim: ./usablePeriod[type="IVL<TS>"] servd: ./StartDate and ./EndDate
telecom	Σ	0..*	ContactPoint	There are no (further) constraints on this element Element id Practitioner.telecom Short description A contact detail for the practitioner (that apply to all roles) Definition A contact detail for the practitioner, e.g. a telephone number or an email address. Requirements Need to know how to reach a practitioner independent to any roles the practitioner may have. Comments Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific. Data type ContactPoint Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PRT-15, STF-10, ROL-12 rim: ./telecom servd: ./ContactPoints
id		0..1	string	There are no (further) constraints on this element Element id Practitioner.telecom.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.telecom.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
system	Σ I	0..1	codeBinding	There are no (further) constraints on this element Element id Practitioner.telecom.system Short description phone \| fax \| email \| pager \| url \| sms \| other Definition Telecommunications form for contact point - what communications system is required to make use of the contact. Data type code Binding Telecommunications form for contact point. ContactPointSystem (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XTN.3 rim: ./scheme servd: ./ContactPointType
value	Σ	0..1	string	There are no (further) constraints on this element Element id Practitioner.telecom.value Short description The actual contact point details Definition The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Requirements Need to support legacy numbers that are not in a tightly controlled format. Comments Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XTN.1 (or XTN.12) rim: ./url servd: ./Value
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id Practitioner.telecom.use Short description home \| work \| temp \| old \| mobile - purpose of this contact point Definition Identifies the purpose for the contact point. Requirements Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Comments Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Data type code Binding Use of contact point. ContactPointUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XTN.2 - but often indicated by field rim: unique(./use) servd: ./ContactPointPurpose
rank	Σ	0..1	positiveInt	There are no (further) constraints on this element Element id Practitioner.telecom.rank Short description Specify preferred order of use (1 = highest) Definition Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Comments Note that rank does not necessarily follow the order in which the contacts are represented in the instance. Data type positiveInt Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: n/a rim: n/a
period	Σ	0..1	Period	There are no (further) constraints on this element Element id Practitioner.telecom.period Short description Time period when the contact point was/is in use Definition Time period when the contact point was/is in use. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: N/A rim: ./usablePeriod[type="IVL<TS>"] servd: ./StartDate and ./EndDate
address	Σ	0..*	Address	There are no (further) constraints on this element Element id Practitioner.address Short description Address(es) of the practitioner that are not role specific (typically home address) Definition Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. Requirements The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. Comments The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address). Data type Address Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: ORC-24, STF-11, ROL-11, PRT-14 rim: ./addr servd: ./Addresses
id		0..1	string	There are no (further) constraints on this element Element id Practitioner.address.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.address.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id Practitioner.address.use Short description home \| work \| temp \| old \| billing - purpose of this address Definition The purpose of this address. Requirements Allows an appropriate address to be chosen from a list of many. Comments Applications can assume that an address is current unless it explicitly says that it is temporary or old. Data type code Binding The use of an address. AddressUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General home Mappings v2: XAD.7 rim: unique(./use) servd: ./AddressPurpose
type	Σ	0..1	codeBinding	There are no (further) constraints on this element Element id Practitioner.address.type Short description postal \| physical \| both Definition Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. Comments The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). Data type code Binding The type of an address (physical / postal). AddressType (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General both Mappings v2: XAD.18 rim: unique(./use) vcard: address type parameter
text	Σ	0..1	string	There are no (further) constraints on this element Element id Practitioner.address.text Short description Text representation of the address Definition Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. Requirements A renderable, unencoded form. Comments Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 137 Nowhere Street, Erewhon 9132 Mappings v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6 rim: ./formatted vcard: address label parameter
line	Σ	0..*	string	There are no (further) constraints on this element Element id Practitioner.address.line Short description Street name, number, direction & P.O. Box etc. Definition This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 137 Nowhere Street Mappings v2: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address) rim: AD.part[parttype = AL] vcard: street servd: ./StreetAddress (newline delimitted)
city	Σ	0..1	string	There are no (further) constraints on this element Element id Practitioner.address.city Short description Name of city, town etc. Alternate names Municpality Definition The name of the city, town, suburb, village or other community or delivery center. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General Erewhon Mappings v2: XAD.3 rim: AD.part[parttype = CTY] vcard: locality servd: ./Jurisdiction
district	Σ	0..1	string	There are no (further) constraints on this element Element id Practitioner.address.district Short description District name (aka county) Alternate names County Definition The name of the administrative area (county). Comments District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General Madison Mappings v2: XAD.9 rim: AD.part[parttype = CNT \| CPA]
state	Σ	0..1	string	There are no (further) constraints on this element Element id Practitioner.address.state Short description Sub-unit of country (abbreviations ok) Alternate names Province, Territory Definition Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XAD.4 rim: AD.part[parttype = STA] vcard: region servd: ./Region
postalCode	Σ	0..1	string	There are no (further) constraints on this element Element id Practitioner.address.postalCode Short description Postal code for area Alternate names Zip Definition A postal code designating a region defined by the postal service. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 9132 Mappings v2: XAD.5 rim: AD.part[parttype = ZIP] vcard: code servd: ./PostalIdentificationCode
country	Σ	0..1	string	There are no (further) constraints on this element Element id Practitioner.address.country Short description Country (e.g. can be ISO 3166 2 or 3 letter code) Definition Country - a nation as commonly understood or generally accepted. Comments ISO 3166 3 letter codes can be used in place of a human readable country name. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XAD.6 rim: AD.part[parttype = CNT] vcard: country servd: ./Country
period	Σ	0..1	Period	There are no (further) constraints on this element Element id Practitioner.address.period Short description Time period when address was/is in use Definition Time period when address was/is in use. Requirements Allows addresses to be placed in historical context. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General { "start": "2010-03-23", "end": "2010-07-01" } Mappings v2: XAD.12 / XAD.13 + XAD.14 rim: ./usablePeriod[type="IVL<TS>"] servd: ./StartDate and ./EndDate
gender	Σ	0..1	codeBinding	There are no (further) constraints on this element Element id Practitioner.gender Short description male \| female \| other \| unknown Definition Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Requirements Needed to address the person correctly. Comments SHOULD NOT be populated when sending a message. Data type code Binding The gender of a person used for administrative purposes. AdministrativeGender (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: STF-5 rim: ./administrativeGender servd: ./GenderCode
birthDate	Σ	0..1	date	There are no (further) constraints on this element Element id Practitioner.birthDate Short description The date on which the practitioner was born Definition The date of birth for the practitioner. Requirements Needed for identification. Comments SHOULD NOT be populated when sending a message. Data type date Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: STF-6 rim: ./birthTime servd: (not represented in ServD)
photo		0..*	Attachment	There are no (further) constraints on this element Element id Practitioner.photo Short description Image of the person Definition Image of the person. Requirements Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. Data type Attachment Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./subjectOf/ObservationEvent[code="photo"]/value servd: ./ImageURI (only supports the URI reference)
qualification		0..*	BackboneElement	There are no (further) constraints on this element Element id Practitioner.qualification Short description Certification, licenses, or training pertaining to the provision of care Definition The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CER? rim: .playingEntity.playingRole[classCode=QUAL].code servd: ./Qualifications
id		0..1	string	There are no (further) constraints on this element Element id Practitioner.qualification.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.qualification.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.qualification.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
identifier		0..*	Identifier	There are no (further) constraints on this element Element id Practitioner.qualification.identifier Short description An identifier for this qualification for the practitioner Definition An identifier that applies to this person's qualification in this role. Requirements Often, specific identities are assigned for the qualification. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .playingEntity.playingRole[classCode=QUAL].id
code		1..1	CodeableConceptBinding	Element id Practitioner.qualification.code Short description Coded representation of the qualification Definition Coded representation of the qualification. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. To access the ValueSet <a href="https://tgateway.infoway-inforoute.ca/singlesubset.html?id=2.16.840.1.113883.2.20.3.48&versionid=20190813" target="_blank">click here</a> Data type CodeableConcept Binding Specific qualification the practitioner has to provide a service. QualifiedCredentialRoleType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .playingEntity.playingRole[classCode=QUAL].code servd: ./Qualifications.Value
id		0..1	string	There are no (further) constraints on this element Element id Practitioner.qualification.code.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.qualification.code.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
coding	Σ	0..*	Coding	There are no (further) constraints on this element Element id Practitioner.qualification.code.coding Short description Code defined by a terminology system Definition A reference to a code defined by a terminology system. Requirements Allows for alternative encodings within a code system, and translations to other code systems. Comments Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Data type Coding Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CE.1-8, CE.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
id		0..1	string	There are no (further) constraints on this element Element id Practitioner.qualification.code.coding.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.qualification.code.coding.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
system	Σ	1..1	uriFixed Value	Element id Practitioner.qualification.code.coding.system Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code. Requirements Need to be unambiguous about the source of the definition of the symbol. Comments The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value https://fhir.infoway-inforoute.ca/CodeSystem/scptype Mappings v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	Σ	0..1	string	There are no (further) constraints on this element Element id Practitioner.qualification.code.coding.version Short description Version of the system - if relevant Definition The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Comments Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	Σ	1..1	codeBinding	Element id Practitioner.qualification.code.coding.code Short description Symbol in syntax defined by the system Definition A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Requirements Need to refer to a particular code in the system. Data type code Binding HealthcareProviderRoleType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ	1..1	string	There are no (further) constraints on this element Element id Practitioner.qualification.code.coding.display Short description Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system. Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..1	boolean	There are no (further) constraints on this element Element id Practitioner.qualification.code.coding.userSelected Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). Requirements This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Comments Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
text	Σ	0..1	string	There are no (further) constraints on this element Element id Practitioner.qualification.code.text Short description Plain text representation of the concept Definition A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. Requirements The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Comments Very often the text is the same as a displayName of one of the codings. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CE.9. But note many systems use CE.2 for this rim: ./originalText[mediaType/code="text/plain"]/data orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
period		0..1	Period	There are no (further) constraints on this element Element id Practitioner.qualification.period Short description Period during which the qualification is valid Definition Period during which the qualification is valid. Requirements Qualifications are often for a limited period of time, and can be revoked. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .playingEntity.playingRole[classCode=QUAL].effectiveTime servd: ./Qualifications.StartDate and ./Qualifications.EndDate
issuer		0..1	Reference(Organization)	There are no (further) constraints on this element Element id Practitioner.qualification.issuer Short description Organization that regulates and issues the qualification Definition Organization that regulates and issues the qualification. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .playingEntity.playingRole[classCode=QUAL].scoper
communication		0..*	CodeableConceptBinding	Element id Practitioner.communication Short description A language the practitioner can use in patient communication Definition A language the practitioner can use in patient communication. Requirements Knowing which language a practitioner speaks can help in facilitating communication with patients. Comments The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. Data type CodeableConcept Binding A human language. Language (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PID-15, NK1-20, LAN-2 rim: ./languageCommunication servd: ./Languages.LanguageSpokenCode
id		0..1	string	There are no (further) constraints on this element Element id Practitioner.communication.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.communication.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
coding	Σ	0..*	CodingBinding	Element id Practitioner.communication.coding Short description Code defined by a terminology system Definition A reference to a code defined by a terminology system. Requirements Allows for alternative encodings within a code system, and translations to other code systems. Comments Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Data type Coding Binding Language (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CE.1-8, CE.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
id		0..1	string	There are no (further) constraints on this element Element id Practitioner.communication.coding.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.communication.coding.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
system	Σ	1..1	uriFixed Value	Element id Practitioner.communication.coding.system Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code. Requirements Need to be unambiguous about the source of the definition of the symbol. Comments The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value urn:ietf:bcp:47 Mappings v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	Σ	0..1	string	There are no (further) constraints on this element Element id Practitioner.communication.coding.version Short description Version of the system - if relevant Definition The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Comments Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	Σ	1..1	codeBinding	Element id Practitioner.communication.coding.code Short description Symbol in syntax defined by the system Definition A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Requirements Need to refer to a particular code in the system. Data type code Binding Language (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ	1..1	string	There are no (further) constraints on this element Element id Practitioner.communication.coding.display Short description Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system. Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..1	boolean	There are no (further) constraints on this element Element id Practitioner.communication.coding.userSelected Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). Requirements This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Comments Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
text	Σ	0..1	string	There are no (further) constraints on this element Element id Practitioner.communication.text Short description Plain text representation of the concept Definition A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. Requirements The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Comments Very often the text is the same as a displayName of one of the codings. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CE.9. But note many systems use CE.2 for this rim: ./originalText[mediaType/code="text/plain"]/data orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

Documentation:

https://simplifier.net/ontarioeservices/ereferralpractitioner

Last updated on 3/21/2025, 8:47:29 PM

Confirmation

Practitioner

`FOR eREFERRAL USAGE: The meta.profile = http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Practitioner|1.1.0`

To access the ValueSet <a href="https://tgateway.infoway-inforoute.ca/singlesubset.html?id=2.16.840.1.113883.2.20.3.48&versionid=20190813" target="_blank">click here</a>

About

Information

Follow us

Links