This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Todo
Definitions for the hspc-practitioner-hspc-practitioner Profile.
Practitioner(hspc-practitioner) | |
Definition | A person who is directly or indirectly involved in the provisioning of healthcare. |
Control | 1..1 |
Requirements | Need to track doctors, staff, locums etc. for both healthcare practitioners, funders, etc. |
Comments | Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual?. |
Practitioner.id | |
Definition | The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
Requirements | |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID. |
Practitioner.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
Requirements | |
Comments | |
Practitioner.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Requirements | |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible. |
Practitioner.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language The codes SHALL be taken from http://tools.ietf.org/html/bcp47 |
Type | code |
Requirements | |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Practitioner.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Requirements | |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. |
Practitioner.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Control | 0..* |
Type | Resource |
Requirements | |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. |
Practitioner.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | This element introduces a set of slices. The slicing rules are:
|
Practitioner.extension (http://hl7.org/fhir/ExtensionDefinition/practitioner-classification) | |
Definition | Classification of the provider. |
Control | 0..1 |
Binding | Codes for provider classification The codes SHOULD be taken from HSPC Provider Classification Value Set Definition; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | |
Comments | |
Practitioner.extension (http://hl7.org/fhir/ExtensionDefinition/practitioner-administrativeAffiliation) | |
Definition | Provider's administrative affiliation. |
Control | 0..* |
Binding | Codes for provider administrative affiliation The codes SHOULD be taken from HSPC Provider Administrative Affiliation Value Set Definition; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | |
Comments | |
Practitioner.extension (http://hl7.org/fhir/ExtensionDefinition/practitioner-practiceAffiliation) | |
Definition | Provider's practice affiliation. |
Control | 0..* |
Binding | Codes for provider practice affiliations The codes SHOULD be taken from HSPC Provider Practice Affiliation Value Set Definition; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | |
Comments | |
Practitioner.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Practitioner.identifier | |
Definition | An identifier that applies to this person in this role. |
Control | 0..* |
Type | Identifier |
Requirements | Often, specific identities are assigned for the agent. |
Comments | |
Practitioner.identifier.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
Practitioner.identifier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | This element introduces a set of slices. The slicing rules are:
|
Practitioner.identifier.extension (http://hl7.org/fhir/ExtensionDefinition/iso21090-verification) | |
Definition | Method value was verified. |
Control | 0..1 |
Binding | A list of verification methods |
Type | CodeableConcept |
Requirements | |
Comments | |
Practitioner.identifier.use | |
Definition | The purpose of this identifier. |
Control | 0..1 |
Binding | Identifies the purpose for this identifier, if known The codes SHALL be taken from IdentifierUse |
Type | code |
Is Modifier | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Practitioner.identifier.label | |
Definition | A text string for the identifier that can be displayed to a human so they can recognize the identifier. |
Control | 0..1 |
Type | string |
Requirements | Allows humans to make use of identifiers when the identifier system is not known. |
Comments | |
Practitioner.identifier.system | |
Definition | Establishes the namespace in which set of possible id values is unique. |
Control | 0..1 |
Type | uri |
Requirements | There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers. |
Comments | |
Example | http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri |
Practitioner.identifier.value | |
Definition | The portion of the identifier typically displayed to the user and which is unique within the context of the system. |
Control | 0..1 |
Type | string |
Requirements | |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. |
Example | 123456 |
Practitioner.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Control | 0..1 |
Type | Period |
Requirements | |
Comments | |
Practitioner.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Control | 0..1 |
Type | Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Organization)) |
Requirements | |
Comments | The reference may be just a text description of the assigner. |
Practitioner.name | |
Definition | A name associated with the person. |
Control | 0..1 |
Type | HumanName |
Requirements | Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. |
Comments | |
Practitioner.telecom | |
Definition | A contact detail for the practitioner, e.g. a telephone number or an email address. |
Control | 0..* |
Type | ContactPoint |
Requirements | Need to know how to reach a practitioner. |
Comments | Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification. |
Practitioner.address | |
Definition | The postal address where the practitioner can be found or visited or to which mail can be delivered. |
Control | 0..* |
Type | Address |
Requirements | Need to keep track where the practitioner can found during work or for directing mail. |
Comments | |
Practitioner.gender | |
Definition | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. |
Control | 0..1 |
Binding | The gender of a person used for administrative purposes The codes SHALL be taken from AdministrativeGender |
Type | code |
Requirements | Needed to address the person correctly. |
Comments | |
Practitioner.birthDate | |
Definition | The date of birth for the practitioner. |
Control | 0..1 |
Type | date |
Requirements | Needed for identification. |
Comments | |
Practitioner.photo | |
Definition | Image of the person. |
Control | 0..* |
Type | Attachment |
Requirements | Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. |
Comments | |
Practitioner.practitionerRole | |
Definition | The list of Roles/Organizations that the Practitioner is associated with. |
Control | 0..* |
Requirements | |
Comments | |
Practitioner.practitionerRole.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
Practitioner.practitionerRole.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Practitioner.practitionerRole.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Practitioner.practitionerRole.managingOrganization | |
Definition | The Organization where the Practitioner performs the roles associated. |
Control | 0..1 |
Type | Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Organization)) |
Requirements | |
Comments | |
Practitioner.practitionerRole.role | |
Definition | Roles which this practitioner is authorized to perform for the organization. |
Control | 0..1 |
Binding | The role a person plays representing an organization For example codes, see PractitionerRole |
Type | CodeableConcept |
Requirements | Need to know what authority the practitioner has - what can they do?. |
Comments | A person may have more than one role. At least one role is required. |
Practitioner.practitionerRole.specialty | |
Definition | Specific specialty of the practitioner. |
Control | 0..* |
Binding | Specific specialty associated with the agency For example codes, see PractitionerSpecialty |
Type | CodeableConcept |
Requirements | |
Comments | |
Practitioner.practitionerRole.period | |
Definition | The period during which the person is authorized to act as a practitioner in these role(s) for the organization. |
Control | 0..1 |
Type | Period |
Requirements | Even after the agencies is revoked, the fact that it existed must still be recorded. |
Comments | |
Practitioner.practitionerRole.location | |
Definition | The location(s) at which this practitioner provides care. |
Control | 0..* |
Type | Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Location)) |
Requirements | |
Comments | |
Practitioner.practitionerRole.healthcareService | |
Definition | The list of healthcare services that this worker offers at this location of this organization. |
Control | 0..* |
Type | Reference(Profile = (Profile = http://hl7.org/fhir/Profile/HealthcareService)) |
Requirements | |
Comments | |
Practitioner.qualification | |
Definition | Qualifications obtained by training and certification. |
Control | 0..* |
Requirements | |
Comments | |
Practitioner.qualification.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
Practitioner.qualification.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | This element introduces a set of slices. The slicing rules are:
|
Practitioner.qualification.extension (http://hl7.org/fhir/ExtensionDefinition/practitioner-credentialStatus) | |
Definition | Provider's credential/qualification status. |
Control | 0..1 |
Binding | Codes for Status of the provider certificate/license The codes SHOULD be taken from HSPC Provider Qualification Status Value Set Definition; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | |
Comments | |
Practitioner.qualification.extension (http://hl7.org/fhir/ExtensionDefinition/practitioner-subType) | |
Definition | Provider's qualification sub type. |
Control | 0..1 |
Binding | Codes for qualification sub-types The codes SHOULD be taken from HSPC Provider Qualification Status Value Set Definition; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements | |
Comments | |
Practitioner.qualification.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Practitioner.qualification.identifier | |
Definition | An identifier that applies to this person's qualification in this role. |
Control | 0..* |
Type | Identifier |
Requirements | Often, specific identities are assigned for the qualification. |
Comments | |
Practitioner.qualification.code | |
Definition | Coded representation of the qualification. |
Control | 1..1 |
Binding | Specific qualification the practitioner has to provide a service For example codes, see ANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2 |
Type | CodeableConcept |
Requirements | |
Comments | |
Practitioner.qualification.period | |
Definition | Period during which the qualification is valid. |
Control | 0..1 |
Type | Period |
Requirements | Qualifications are often for a limited period of time, and can be revoked. |
Comments | |
Practitioner.qualification.issuer | |
Definition | Organization that regulates and issues the qualification. |
Control | 0..1 |
Type | Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Organization)) |
Requirements | |
Comments | |
Practitioner.communication | |
Definition | A language the practitioner is able to use in patient communication. |
Control | 0..* |
Binding | A human language The codes SHALL be taken from http://tools.ietf.org/html/bcp47 |
Type | CodeableConcept |
Requirements | Knowing which language a practitioner speaks can help in facilitating communication with patients. |
Comments | The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. |
Practitioner.communication.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
Practitioner.communication.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | This element introduces a set of slices. The slicing rules are:
|
Practitioner.communication.extension (http://hl7.org/fhir/Profile/hspc-practitioner-communicationMode) | |
Definition | Mode to communicate with practitioner. |
Control | 0..1 |
Type | CodeableConcept |
Requirements | |
Comments | |
Practitioner.communication.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the V3 Core Principles for more information. Ordering of codings is undefined and SHALL not be used to infer meaning. |
Practitioner.communication.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..1 |
Type | string |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |