Profiles & Operations Index > Profile: Practitioner (Submission)
Profile: Practitioner (Submission)
Simplifier project page: Practitioner (Submission)
Derived from: Practitioner (R4)
Canonical_URL | Profile_Status | Profile_Version | FHIR_Version |
---|---|---|---|
http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-profile-Practitioner-submission | active | 4.0.1 | 4.0.1 |
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work
Differential View
Practitioner | S I | Practitioner | There are no (further) constraints on this element Element IdPractitioner A person with a formal responsibility in the provisioning of healthcare or related services DefinitionA person who is directly or indirectly involved in the provisioning of healthcare.
| |
meta | S Σ | 1..1 | Meta | There are no (further) constraints on this element Element IdPractitioner.meta Metadata about the resource DefinitionThe 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.
|
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element IdPractitioner.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. 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.
|
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element IdPractitioner.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. 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.
|
source | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdPractitioner.meta.source Identifies where the resource comes from DefinitionA 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. 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.
|
profile | S Σ | 1..* | canonical(StructureDefinition) | There are no (further) constraints on this element Element IdPractitioner.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. 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. canonical(StructureDefinition) Constraints
|
security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdPractitioner.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. 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. Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible)Constraints
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdPractitioner.meta.tag Tags applied to this resource DefinitionTags 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. 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. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". CommonTags (example)Constraints
|
identifier | S Σ | 1..1 | Identifier | There are no (further) constraints on this element Element IdPractitioner.identifier An identifier for the person as this agent DefinitionAn identifier that applies to this person in this role. Often, specific identities are assigned for the agent.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitioner.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPractitioner.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. 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
|
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element IdPractitioner.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdPractitioner.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitioner.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdPractitioner.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
active | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitioner.active Whether this practitioner's record is in active use DefinitionWhether this practitioner's record is in active use. Need to be able to mark a practitioner record as not to be used because it was created in error. 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. This resource is generally assumed to be active if no value is provided for the active element
|
name | S Σ | 1..1 | HumanName | There are no (further) constraints on this element Element IdPractitioner.name The name(s) associated with the practitioner DefinitionThe name(s) associated with the practitioner. 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. 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:
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitioner.name.use usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name. NameUse (required)Constraints
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.name.text Text representation of the full name DefinitionSpecifies 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. A renderable, unencoded form. 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.
|
family | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdPractitioner.name.family Family name (often called 'Surname') Alternate namessurname DefinitionThe 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. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
|
given | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.name.given Given names (not always 'first'). Includes middle names Alternate namesfirst name, middle name DefinitionGiven name. 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.
|
prefix | S Σ | 0..* | string | There are no (further) constraints on this element Element IdPractitioner.name.prefix Parts that come before the name DefinitionPart 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
suffix | S Σ | 0..* | string | There are no (further) constraints on this element Element IdPractitioner.name.suffix Parts that come after the name DefinitionPart 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitioner.name.period Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
telecom | Σ I | 0..* | ContactPoint | There are no (further) constraints on this element Element IdPractitioner.telecom A contact detail for the practitioner (that apply to all roles) DefinitionA contact detail for the practitioner, e.g. a telephone number or an email address. Need to know how to reach a practitioner independent to any roles the practitioner may have. 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.
|
address | Σ | 0..* | Address | There are no (further) constraints on this element Element IdPractitioner.address Address(es) of the practitioner that are not role specific (typically home address) DefinitionAddress(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. 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. 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).
|
gender | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitioner.gender male | female | other | unknown DefinitionAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Needed to address the person correctly. Note that FHIR strings SHALL NOT exceed 1MB in size The gender of a person used for administrative purposes. AdministrativeGender (required)Constraints
|
birthDate | Σ | 0..1 | date | There are no (further) constraints on this element Element IdPractitioner.birthDate The date on which the practitioner was born DefinitionThe date of birth for the practitioner. Needed for identification.
|
photo | I | 0..* | Attachment | There are no (further) constraints on this element Element IdPractitioner.photo Image of the person DefinitionImage of the person. Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".
|
qualification | 0..* | BackboneElement | There are no (further) constraints on this element Element IdPractitioner.qualification Certification, licenses, or training pertaining to the provision of care DefinitionThe 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.
| |
identifier | 0..* | Identifier | There are no (further) constraints on this element Element IdPractitioner.qualification.identifier An identifier for this qualification for the practitioner DefinitionAn identifier that applies to this person's qualification in this role. Often, specific identities are assigned for the qualification.
| |
code | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdPractitioner.qualification.code Coded representation of the qualification DefinitionCoded representation of the qualification. 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. Specific qualification the practitioner has to provide a service. v2.0360.2.7 (example)Constraints
| |
period | I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitioner.qualification.period Period during which the qualification is valid DefinitionPeriod during which the qualification is valid. Qualifications are often for a limited period of time, and can be revoked. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
issuer | I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdPractitioner.qualification.issuer Organization that regulates and issues the qualification DefinitionOrganization that regulates and issues the qualification. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
communication | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdPractitioner.communication A language the practitioner can use in patient communication DefinitionA language the practitioner can use in patient communication. Knowing which language a practitioner speaks can help in facilitating communication with patients. 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. A human language. CommonLanguages (preferred)Constraints
|
Hybrid View
Practitioner | S I | Practitioner | There are no (further) constraints on this element Element IdPractitioner A person with a formal responsibility in the provisioning of healthcare or related services DefinitionA person who is directly or indirectly involved in the provisioning of healthcare.
| |
meta | S Σ | 1..1 | Meta | There are no (further) constraints on this element Element IdPractitioner.meta Metadata about the resource DefinitionThe 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.
|
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element IdPractitioner.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. 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.
|
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element IdPractitioner.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. 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.
|
source | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdPractitioner.meta.source Identifies where the resource comes from DefinitionA 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. 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.
|
profile | S Σ | 1..* | canonical(StructureDefinition) | There are no (further) constraints on this element Element IdPractitioner.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. 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. canonical(StructureDefinition) Constraints
|
security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdPractitioner.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. 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. Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible)Constraints
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdPractitioner.meta.tag Tags applied to this resource DefinitionTags 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. 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. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". CommonTags (example)Constraints
|
identifier | S Σ | 1..1 | Identifier | There are no (further) constraints on this element Element IdPractitioner.identifier An identifier for the person as this agent DefinitionAn identifier that applies to this person in this role. Often, specific identities are assigned for the agent.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitioner.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPractitioner.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. 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
|
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element IdPractitioner.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdPractitioner.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitioner.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdPractitioner.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
active | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitioner.active Whether this practitioner's record is in active use DefinitionWhether this practitioner's record is in active use. Need to be able to mark a practitioner record as not to be used because it was created in error. 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. This resource is generally assumed to be active if no value is provided for the active element
|
name | S Σ | 1..1 | HumanName | There are no (further) constraints on this element Element IdPractitioner.name The name(s) associated with the practitioner DefinitionThe name(s) associated with the practitioner. 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. 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:
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitioner.name.use usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name. NameUse (required)Constraints
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.name.text Text representation of the full name DefinitionSpecifies 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. A renderable, unencoded form. 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.
|
family | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdPractitioner.name.family Family name (often called 'Surname') Alternate namessurname DefinitionThe 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. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
|
given | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.name.given Given names (not always 'first'). Includes middle names Alternate namesfirst name, middle name DefinitionGiven name. 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.
|
prefix | S Σ | 0..* | string | There are no (further) constraints on this element Element IdPractitioner.name.prefix Parts that come before the name DefinitionPart 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
suffix | S Σ | 0..* | string | There are no (further) constraints on this element Element IdPractitioner.name.suffix Parts that come after the name DefinitionPart 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitioner.name.period Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
telecom | Σ I | 0..* | ContactPoint | There are no (further) constraints on this element Element IdPractitioner.telecom A contact detail for the practitioner (that apply to all roles) DefinitionA contact detail for the practitioner, e.g. a telephone number or an email address. Need to know how to reach a practitioner independent to any roles the practitioner may have. 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.
|
address | Σ | 0..* | Address | There are no (further) constraints on this element Element IdPractitioner.address Address(es) of the practitioner that are not role specific (typically home address) DefinitionAddress(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. 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. 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).
|
gender | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitioner.gender male | female | other | unknown DefinitionAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Needed to address the person correctly. Note that FHIR strings SHALL NOT exceed 1MB in size The gender of a person used for administrative purposes. AdministrativeGender (required)Constraints
|
birthDate | Σ | 0..1 | date | There are no (further) constraints on this element Element IdPractitioner.birthDate The date on which the practitioner was born DefinitionThe date of birth for the practitioner. Needed for identification.
|
photo | I | 0..* | Attachment | There are no (further) constraints on this element Element IdPractitioner.photo Image of the person DefinitionImage of the person. Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".
|
qualification | 0..* | BackboneElement | There are no (further) constraints on this element Element IdPractitioner.qualification Certification, licenses, or training pertaining to the provision of care DefinitionThe 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.
| |
identifier | 0..* | Identifier | There are no (further) constraints on this element Element IdPractitioner.qualification.identifier An identifier for this qualification for the practitioner DefinitionAn identifier that applies to this person's qualification in this role. Often, specific identities are assigned for the qualification.
| |
code | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdPractitioner.qualification.code Coded representation of the qualification DefinitionCoded representation of the qualification. 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. Specific qualification the practitioner has to provide a service. v2.0360.2.7 (example)Constraints
| |
period | I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitioner.qualification.period Period during which the qualification is valid DefinitionPeriod during which the qualification is valid. Qualifications are often for a limited period of time, and can be revoked. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
issuer | I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdPractitioner.qualification.issuer Organization that regulates and issues the qualification DefinitionOrganization that regulates and issues the qualification. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
communication | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdPractitioner.communication A language the practitioner can use in patient communication DefinitionA language the practitioner can use in patient communication. Knowing which language a practitioner speaks can help in facilitating communication with patients. 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. A human language. CommonLanguages (preferred)Constraints
|
Snapshot View
Practitioner | S I | Practitioner | There are no (further) constraints on this element Element IdPractitioner A person with a formal responsibility in the provisioning of healthcare or related services DefinitionA person who is directly or indirectly involved in the provisioning of healthcare.
| |
meta | S Σ | 1..1 | Meta | There are no (further) constraints on this element Element IdPractitioner.meta Metadata about the resource DefinitionThe 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.
|
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element IdPractitioner.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. 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.
|
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element IdPractitioner.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. 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.
|
source | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdPractitioner.meta.source Identifies where the resource comes from DefinitionA 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. 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.
|
profile | S Σ | 1..* | canonical(StructureDefinition) | There are no (further) constraints on this element Element IdPractitioner.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. 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. canonical(StructureDefinition) Constraints
|
security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdPractitioner.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. 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. Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible)Constraints
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdPractitioner.meta.tag Tags applied to this resource DefinitionTags 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. 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. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". CommonTags (example)Constraints
|
identifier | S Σ | 1..1 | Identifier | There are no (further) constraints on this element Element IdPractitioner.identifier An identifier for the person as this agent DefinitionAn identifier that applies to this person in this role. Often, specific identities are assigned for the agent.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitioner.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPractitioner.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. 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
|
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element IdPractitioner.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdPractitioner.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitioner.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdPractitioner.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
active | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitioner.active Whether this practitioner's record is in active use DefinitionWhether this practitioner's record is in active use. Need to be able to mark a practitioner record as not to be used because it was created in error. 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. This resource is generally assumed to be active if no value is provided for the active element
|
name | S Σ | 1..1 | HumanName | There are no (further) constraints on this element Element IdPractitioner.name The name(s) associated with the practitioner DefinitionThe name(s) associated with the practitioner. 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. 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:
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitioner.name.use usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name. NameUse (required)Constraints
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.name.text Text representation of the full name DefinitionSpecifies 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. A renderable, unencoded form. 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.
|
family | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdPractitioner.name.family Family name (often called 'Surname') Alternate namessurname DefinitionThe 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. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
|
given | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.name.given Given names (not always 'first'). Includes middle names Alternate namesfirst name, middle name DefinitionGiven name. 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.
|
prefix | S Σ | 0..* | string | There are no (further) constraints on this element Element IdPractitioner.name.prefix Parts that come before the name DefinitionPart 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
suffix | S Σ | 0..* | string | There are no (further) constraints on this element Element IdPractitioner.name.suffix Parts that come after the name DefinitionPart 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitioner.name.period Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
telecom | Σ I | 0..* | ContactPoint | There are no (further) constraints on this element Element IdPractitioner.telecom A contact detail for the practitioner (that apply to all roles) DefinitionA contact detail for the practitioner, e.g. a telephone number or an email address. Need to know how to reach a practitioner independent to any roles the practitioner may have. 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.
|
address | Σ | 0..* | Address | There are no (further) constraints on this element Element IdPractitioner.address Address(es) of the practitioner that are not role specific (typically home address) DefinitionAddress(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. 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. 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).
|
gender | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitioner.gender male | female | other | unknown DefinitionAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Needed to address the person correctly. Note that FHIR strings SHALL NOT exceed 1MB in size The gender of a person used for administrative purposes. AdministrativeGender (required)Constraints
|
birthDate | Σ | 0..1 | date | There are no (further) constraints on this element Element IdPractitioner.birthDate The date on which the practitioner was born DefinitionThe date of birth for the practitioner. Needed for identification.
|
photo | I | 0..* | Attachment | There are no (further) constraints on this element Element IdPractitioner.photo Image of the person DefinitionImage of the person. Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".
|
qualification | 0..* | BackboneElement | There are no (further) constraints on this element Element IdPractitioner.qualification Certification, licenses, or training pertaining to the provision of care DefinitionThe 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.
| |
identifier | 0..* | Identifier | There are no (further) constraints on this element Element IdPractitioner.qualification.identifier An identifier for this qualification for the practitioner DefinitionAn identifier that applies to this person's qualification in this role. Often, specific identities are assigned for the qualification.
| |
code | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdPractitioner.qualification.code Coded representation of the qualification DefinitionCoded representation of the qualification. 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. Specific qualification the practitioner has to provide a service. v2.0360.2.7 (example)Constraints
| |
period | I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitioner.qualification.period Period during which the qualification is valid DefinitionPeriod during which the qualification is valid. Qualifications are often for a limited period of time, and can be revoked. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
issuer | I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdPractitioner.qualification.issuer Organization that regulates and issues the qualification DefinitionOrganization that regulates and issues the qualification. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
communication | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdPractitioner.communication A language the practitioner can use in patient communication DefinitionA language the practitioner can use in patient communication. Knowing which language a practitioner speaks can help in facilitating communication with patients. 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. A human language. CommonLanguages (preferred)Constraints
|
Table View
Practitioner | .. | |
Practitioner.meta | 1.. | |
Practitioner.meta.profile | 1.. | |
Practitioner.identifier | 1..1 | |
Practitioner.identifier.system | 1.. | |
Practitioner.identifier.value | 1.. | |
Practitioner.name | 1..1 | |
Practitioner.name.family | 1.. | |
Practitioner.name.given | ..1 | |
Practitioner.name.prefix | .. | |
Practitioner.name.suffix | .. |
JSON View
{ "resourceType": "StructureDefinition", "id": "61aa59b3-be7f-4981-b91a-90cfe7fb7a50", "meta": { "lastUpdated": "2023-09-15T15:05:05.1292674+00:00" }, "text": { "status": "empty", --- We have skipped the narrative for better readability of the resource --- }, "url": "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-profile-Practitioner-submission", "version": "4.0.1", "name": "Practitioner", "title": "Practitioner (Submission)", "status": "active", "date": "2022-09-21", "description": "Practitioner can be the prescriber who authored the originating MedicationRequest (prescription) event or the dispenser responsible for the MedicationDispense event.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Practitioner", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Practitioner", "derivation": "constraint", "differential": { "element": [ { "id": "Practitioner", "path": "Practitioner", "mustSupport": true }, { "id": "Practitioner.meta", "path": "Practitioner.meta", "min": 1, "mustSupport": true }, { "id": "Practitioner.meta.profile", "path": "Practitioner.meta.profile", "min": 1, "mustSupport": true }, { "id": "Practitioner.identifier", "path": "Practitioner.identifier", "min": 1, "max": "1", "mustSupport": true }, { "id": "Practitioner.identifier.system", "path": "Practitioner.identifier.system", "min": 1, "mustSupport": true }, { "id": "Practitioner.identifier.value", "path": "Practitioner.identifier.value", "min": 1, "mustSupport": true }, { "id": "Practitioner.name", "path": "Practitioner.name", "min": 1, "max": "1", "mustSupport": true }, { "id": "Practitioner.name.family", "path": "Practitioner.name.family", "min": 1, "mustSupport": true }, { "id": "Practitioner.name.given", "path": "Practitioner.name.given", "max": "1", "mustSupport": true }, { "id": "Practitioner.name.prefix", "path": "Practitioner.name.prefix", "mustSupport": true }, { "id": "Practitioner.name.suffix", "path": "Practitioner.name.suffix", "mustSupport": true } ] } }
Usage
The Practitioner resource contains practitioner prescriber and dispenser information identified in the DHDR record.
Notes
.id
- used to uniquely identify the resource
- if a persistent identity for the resource is not available to use when constructing a message Bundle for transmission via Direct Messaging, a UUID SHOULD be used in this element (with a corresponding value in Bundle.entry.fullUrl)
.meta.profile
- used to declare conformance to this profile
- populate with a fixed value:
http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-profile-Practitioner-submission|4.0.1
.identifier
SHALL be used to convey business identifier(s) that are specific to this Practitioner such as a college license number
identifier.system
should be URI of a licence regulating body. See global identifiers table in Identifiers page for Ontario college URIs. For unknown provider the URI SHALL behttps://fhir.infoway-inforoute.ca/NamingSystem/ca-on-unknown-prescriber
for locally assigned practitioner identifiers the system SHALL be the local system URL (will be provided during onboarding process) - applies for MedicationAdministration only
identifier.value
should be the CPSO License number for prescribers, or the CPHA License number for pharmacists. For unknown provider the license number SHALL be99999
.name
- this field SHALL contain the name of the physician
- if the name is unavailable, populate "unknown" value