FHIR Artifacts > Structure Definition: Practitioner Profile
Structure Definition: Practitioner Profile
Canonical URL:http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Practitioner
Simplifier project page: Practitioner
Derived from: Practitioner (R4)
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work
Differential View
Practitioner | 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) | 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.
|
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 Σ | 0..* | 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 Σ | 0..* | 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 | S Σ ?! | 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 | S Σ | 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 Σ | 0..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 Σ | 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 | Σ | 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 | Σ | 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 | S Σ 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.
|
system | S Σ I | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitioner.telecom.system phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point. ContactPointSystem (required)Constraints
|
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdPractitioner.telecom.value The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
|
use | S Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitioner.telecom.use home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point. ContactPointUse (required)Constraints
|
rank | S Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdPractitioner.telecom.rank Specify preferred order of use (1 = highest) DefinitionSpecifies 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. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitioner.telecom.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in 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.
|
address | S Σ | 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).
|
use | S Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitioner.address.use home | work | temp | old | billing - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address. AddressUse (required)Constraints
General home Mappings
|
type | S Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitioner.address.type postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. 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). The type of an address (physical / postal). AddressType (required)Constraints
General both Mappings
|
text | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.address.text Text representation of the address DefinitionSpecifies 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. A renderable, unencoded form. 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.
General 137 Nowhere Street, Erewhon 9132 Mappings
|
line | S Σ | 0..* | string | There are no (further) constraints on this element Element IdPractitioner.address.line Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. Note that FHIR strings SHALL NOT exceed 1MB in size
General 137 Nowhere Street Mappings
|
city | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.address.city Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, suburb, village or other community or delivery center. Note that FHIR strings SHALL NOT exceed 1MB in size
General Erewhon Mappings
|
district | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.address.district District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). 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.
General Madison Mappings
|
state | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.address.state Sub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-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). Note that FHIR strings SHALL NOT exceed 1MB in size
|
postalCode | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.address.postalCode Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. Note that FHIR strings SHALL NOT exceed 1MB in size
General 9132 Mappings
|
country | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.address.country Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. ISO 3166 3 letter codes can be used in place of a human readable country name.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitioner.address.period Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses 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.
General { "start": "2010-03-23", "end": "2010-07-01" } Mappings
|
gender | S Σ | 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 | S Σ | 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 | S | 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 | S | 1..1 | CodeableConceptBinding | 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. To access the ValueSet click hereSpecific qualification the practitioner has to provide a service. HealthcareProviderRoleType (extensible)Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdPractitioner.qualification.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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.
|
system | S Σ | 0..1 | uriFixed Value | Element IdPractitioner.qualification.code.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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.
https://fhir.infoway-inforoute.ca/CodeSystem/scptype
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.qualification.code.coding.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | S Σ | 0..1 | codeBinding | Element IdPractitioner.qualification.code.coding.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size HealthcareProviderRoleType (extensible) Constraints
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.qualification.code.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitioner.qualification.code.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.qualification.code.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
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 | S | 0..* | CodeableConceptBinding | 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. Language (preferred)Constraints
|
coding | S Σ | 0..* | CodingBinding | Element IdPractitioner.communication.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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.
|
system | S Σ | 0..1 | uriFixed Value | Element IdPractitioner.communication.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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.
urn:ietf:bcp:47
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.communication.coding.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | S Σ | 0..1 | codeBinding | Element IdPractitioner.communication.coding.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.communication.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitioner.communication.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
text | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.communication.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
Hybrid View
Practitioner | 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) | 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.
|
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 Σ | 0..* | 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 Σ | 0..* | 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 | S Σ ?! | 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 | S Σ | 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 Σ | 0..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 Σ | 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 | Σ | 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 | Σ | 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 | S Σ 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.
|
system | S Σ I | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitioner.telecom.system phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point. ContactPointSystem (required)Constraints
|
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdPractitioner.telecom.value The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
|
use | S Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitioner.telecom.use home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point. ContactPointUse (required)Constraints
|
rank | S Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdPractitioner.telecom.rank Specify preferred order of use (1 = highest) DefinitionSpecifies 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. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitioner.telecom.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in 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.
|
address | S Σ | 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).
|
use | S Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitioner.address.use home | work | temp | old | billing - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address. AddressUse (required)Constraints
General home Mappings
|
type | S Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitioner.address.type postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. 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). The type of an address (physical / postal). AddressType (required)Constraints
General both Mappings
|
text | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.address.text Text representation of the address DefinitionSpecifies 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. A renderable, unencoded form. 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.
General 137 Nowhere Street, Erewhon 9132 Mappings
|
line | S Σ | 0..* | string | There are no (further) constraints on this element Element IdPractitioner.address.line Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. Note that FHIR strings SHALL NOT exceed 1MB in size
General 137 Nowhere Street Mappings
|
city | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.address.city Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, suburb, village or other community or delivery center. Note that FHIR strings SHALL NOT exceed 1MB in size
General Erewhon Mappings
|
district | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.address.district District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). 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.
General Madison Mappings
|
state | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.address.state Sub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-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). Note that FHIR strings SHALL NOT exceed 1MB in size
|
postalCode | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.address.postalCode Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. Note that FHIR strings SHALL NOT exceed 1MB in size
General 9132 Mappings
|
country | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.address.country Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. ISO 3166 3 letter codes can be used in place of a human readable country name.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitioner.address.period Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses 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.
General { "start": "2010-03-23", "end": "2010-07-01" } Mappings
|
gender | S Σ | 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 | S Σ | 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 | S | 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 | S | 1..1 | CodeableConceptBinding | 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. To access the ValueSet click hereSpecific qualification the practitioner has to provide a service. HealthcareProviderRoleType (extensible)Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdPractitioner.qualification.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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.
|
system | S Σ | 0..1 | uriFixed Value | Element IdPractitioner.qualification.code.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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.
https://fhir.infoway-inforoute.ca/CodeSystem/scptype
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.qualification.code.coding.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | S Σ | 0..1 | codeBinding | Element IdPractitioner.qualification.code.coding.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size HealthcareProviderRoleType (extensible) Constraints
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.qualification.code.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitioner.qualification.code.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.qualification.code.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
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 | S | 0..* | CodeableConceptBinding | 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. Language (preferred)Constraints
|
coding | S Σ | 0..* | CodingBinding | Element IdPractitioner.communication.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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.
|
system | S Σ | 0..1 | uriFixed Value | Element IdPractitioner.communication.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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.
urn:ietf:bcp:47
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.communication.coding.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | S Σ | 0..1 | codeBinding | Element IdPractitioner.communication.coding.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.communication.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitioner.communication.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
text | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.communication.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
Snapshot View
Practitioner | 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) | 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.
|
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 Σ | 0..* | 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 Σ | 0..* | 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 | S Σ ?! | 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 | S Σ | 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 Σ | 0..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 Σ | 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 | Σ | 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 | Σ | 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 | S Σ 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.
|
system | S Σ I | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitioner.telecom.system phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point. ContactPointSystem (required)Constraints
|
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdPractitioner.telecom.value The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
|
use | S Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitioner.telecom.use home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point. ContactPointUse (required)Constraints
|
rank | S Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdPractitioner.telecom.rank Specify preferred order of use (1 = highest) DefinitionSpecifies 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. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitioner.telecom.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in 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.
|
address | S Σ | 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).
|
use | S Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitioner.address.use home | work | temp | old | billing - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address. AddressUse (required)Constraints
General home Mappings
|
type | S Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitioner.address.type postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. 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). The type of an address (physical / postal). AddressType (required)Constraints
General both Mappings
|
text | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.address.text Text representation of the address DefinitionSpecifies 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. A renderable, unencoded form. 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.
General 137 Nowhere Street, Erewhon 9132 Mappings
|
line | S Σ | 0..* | string | There are no (further) constraints on this element Element IdPractitioner.address.line Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. Note that FHIR strings SHALL NOT exceed 1MB in size
General 137 Nowhere Street Mappings
|
city | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.address.city Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, suburb, village or other community or delivery center. Note that FHIR strings SHALL NOT exceed 1MB in size
General Erewhon Mappings
|
district | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.address.district District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). 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.
General Madison Mappings
|
state | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.address.state Sub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-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). Note that FHIR strings SHALL NOT exceed 1MB in size
|
postalCode | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.address.postalCode Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. Note that FHIR strings SHALL NOT exceed 1MB in size
General 9132 Mappings
|
country | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.address.country Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. ISO 3166 3 letter codes can be used in place of a human readable country name.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitioner.address.period Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses 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.
General { "start": "2010-03-23", "end": "2010-07-01" } Mappings
|
gender | S Σ | 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 | S Σ | 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 | S | 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 | S | 1..1 | CodeableConceptBinding | 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. To access the ValueSet click hereSpecific qualification the practitioner has to provide a service. HealthcareProviderRoleType (extensible)Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdPractitioner.qualification.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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.
|
system | S Σ | 0..1 | uriFixed Value | Element IdPractitioner.qualification.code.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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.
https://fhir.infoway-inforoute.ca/CodeSystem/scptype
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.qualification.code.coding.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | S Σ | 0..1 | codeBinding | Element IdPractitioner.qualification.code.coding.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size HealthcareProviderRoleType (extensible) Constraints
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.qualification.code.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitioner.qualification.code.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.qualification.code.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
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 | S | 0..* | CodeableConceptBinding | 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. Language (preferred)Constraints
|
coding | S Σ | 0..* | CodingBinding | Element IdPractitioner.communication.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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.
|
system | S Σ | 0..1 | uriFixed Value | Element IdPractitioner.communication.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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.
urn:ietf:bcp:47
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.communication.coding.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | S Σ | 0..1 | codeBinding | Element IdPractitioner.communication.coding.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.communication.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitioner.communication.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
text | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitioner.communication.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
Table View
Practitioner | .. | |
Practitioner.meta | 1.. | |
Practitioner.meta.profile | 1.. | |
Practitioner.identifier | .. | |
Practitioner.identifier.system | 1.. | |
Practitioner.identifier.value | 1.. | |
Practitioner.name | .. | |
Practitioner.name.use | .. | |
Practitioner.name.text | .. | |
Practitioner.name.family | .. | |
Practitioner.name.given | 1.. | |
Practitioner.telecom | .. | |
Practitioner.telecom.system | .. | |
Practitioner.telecom.value | 1.. | |
Practitioner.telecom.use | .. | |
Practitioner.telecom.rank | .. | |
Practitioner.address | .. | |
Practitioner.address.use | .. | |
Practitioner.address.type | .. | |
Practitioner.address.text | .. | |
Practitioner.address.line | .. | |
Practitioner.address.city | .. | |
Practitioner.address.state | .. | |
Practitioner.address.postalCode | .. | |
Practitioner.address.country | .. | |
Practitioner.gender | .. | |
Practitioner.birthDate | .. | |
Practitioner.qualification | .. | |
Practitioner.qualification.code | .. | |
Practitioner.qualification.code.coding | .. | |
Practitioner.qualification.code.coding.system | .. | |
Practitioner.qualification.code.coding.code | .. | |
Practitioner.qualification.code.coding.display | .. | |
Practitioner.communication | .. | |
Practitioner.communication.coding | .. | |
Practitioner.communication.coding.system | .. | |
Practitioner.communication.coding.code | .. | |
Practitioner.communication.coding.display | .. | |
Practitioner.communication.text | .. |
JSON View
{ "resourceType": "StructureDefinition", "id": "ca-on-eReferral-profile-Practitioner", "url": "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Practitioner", "version": "1.0.0", "name": "EReferralPractitioner", "title": "Practitioner", "status": "draft", "description": "Practitioner covers all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities and this Resource is used for attribution of activities and responsibilities to these individuals. Practitioners include (but are not limited to): physicians, other clinicians, home care providers, administrative staff, IT personnel, and more.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Practitioner", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Practitioner", "derivation": "constraint", "differential": { "element": [ { "id": "Practitioner.meta", "path": "Practitioner.meta", "min": 1, "mustSupport": true }, { "id": "Practitioner.meta.profile", "path": "Practitioner.meta.profile", "comment": "#### **_` FOR eREFERRAL USAGE: The meta.profile = http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Practitioner|1.0.0 `_**\n\nIt 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.", "min": 1, "mustSupport": true }, { "id": "Practitioner.identifier", "path": "Practitioner.identifier", "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", "mustSupport": true }, { "id": "Practitioner.name.use", "path": "Practitioner.name.use", "mustSupport": true }, { "id": "Practitioner.name.text", "path": "Practitioner.name.text", "mustSupport": true }, { "id": "Practitioner.name.family", "path": "Practitioner.name.family", "mustSupport": true }, { "id": "Practitioner.name.given", "path": "Practitioner.name.given", "min": 1, "mustSupport": true }, { "id": "Practitioner.telecom", "path": "Practitioner.telecom", "mustSupport": true }, { "id": "Practitioner.telecom.system", "path": "Practitioner.telecom.system", "mustSupport": true }, { "id": "Practitioner.telecom.value", "path": "Practitioner.telecom.value", "min": 1, "mustSupport": true }, { "id": "Practitioner.telecom.use", "path": "Practitioner.telecom.use", "mustSupport": true }, { "id": "Practitioner.telecom.rank", "path": "Practitioner.telecom.rank", "mustSupport": true }, { "id": "Practitioner.address", "path": "Practitioner.address", "mustSupport": true }, { "id": "Practitioner.address.use", "path": "Practitioner.address.use", "mustSupport": true }, { "id": "Practitioner.address.type", "path": "Practitioner.address.type", "mustSupport": true }, { "id": "Practitioner.address.text", "path": "Practitioner.address.text", "mustSupport": true }, { "id": "Practitioner.address.line", "path": "Practitioner.address.line", "mustSupport": true }, { "id": "Practitioner.address.city", "path": "Practitioner.address.city", "mustSupport": true }, { "id": "Practitioner.address.state", "path": "Practitioner.address.state", "mustSupport": true }, { "id": "Practitioner.address.postalCode", "path": "Practitioner.address.postalCode", "mustSupport": true }, { "id": "Practitioner.address.country", "path": "Practitioner.address.country", "mustSupport": true }, { "id": "Practitioner.gender", "path": "Practitioner.gender", "mustSupport": true }, { "id": "Practitioner.birthDate", "path": "Practitioner.birthDate", "mustSupport": true }, { "id": "Practitioner.qualification", "path": "Practitioner.qualification", "mustSupport": true }, { "id": "Practitioner.qualification.code", "path": "Practitioner.qualification.code", "comment": "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.\n\n### 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>", "mustSupport": true, "binding": { "strength": "extensible", "valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/healthcareproviderroletype" } }, { "id": "Practitioner.qualification.code.coding", "path": "Practitioner.qualification.code.coding", "mustSupport": true }, { "id": "Practitioner.qualification.code.coding.system", "path": "Practitioner.qualification.code.coding.system", "fixedUri": "https://fhir.infoway-inforoute.ca/CodeSystem/scptype", "mustSupport": true }, { "id": "Practitioner.qualification.code.coding.code", "path": "Practitioner.qualification.code.coding.code", "mustSupport": true, "binding": { "strength": "extensible", "valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/healthcareproviderroletype" } }, { "id": "Practitioner.qualification.code.coding.display", "path": "Practitioner.qualification.code.coding.display", "mustSupport": true }, { "id": "Practitioner.communication", "path": "Practitioner.communication", "mustSupport": true, "binding": { "strength": "preferred", "valueSet": "http://ehealthontario.ca/fhir/ValueSet/human-language" } }, { "id": "Practitioner.communication.coding", "path": "Practitioner.communication.coding", "mustSupport": true, "binding": { "strength": "preferred", "valueSet": "http://ehealthontario.ca/fhir/ValueSet/human-language" } }, { "id": "Practitioner.communication.coding.system", "path": "Practitioner.communication.coding.system", "fixedUri": "urn:ietf:bcp:47", "mustSupport": true }, { "id": "Practitioner.communication.coding.code", "path": "Practitioner.communication.coding.code", "mustSupport": true, "binding": { "strength": "preferred", "valueSet": "http://ehealthontario.ca/fhir/ValueSet/human-language" } }, { "id": "Practitioner.communication.coding.display", "path": "Practitioner.communication.coding.display", "mustSupport": true }, { "id": "Practitioner.communication.text", "path": "Practitioner.communication.text", "mustSupport": true } ] } }
Usage
The Practitioner Resource is used for all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities. The Resource is used for attribution of activities and responsibilities to these individuals. Practitioners include (but are not limited to): physicians, other clinicians, home care providers, administrative staff, and more.
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-eReferral-profile-Practitioner|1.0.0
.identifier
- business identifier(s) that are specific to this PractitionerRole
- receiving systems SHALL accept and save any identifiers from the requesting system (e.g., CPSO #)
.name
- the name of the practitioner
.name.family
SHALL always be populated.name.given
use multiple instances if the practitioner has multiple given names (e.g. first and middle names)
.telecom
- PractitionerRole.telecom is the preferred location for this information
.address
- PractitionerRole.address is the preferred location for this information