UKCorePractitioner (Practitioner) | C | | Practitioner | There are no (further) constraints on this element Element idPractitioner Short descriptionA 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.
Data typePractitioner Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() Mappings- rim: Entity. Role, or Act
- v2: PRD (as one example)
- rim: Role
- servd: Provider
|
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.id Short descriptionLogical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
CommentsThe only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Data typestring |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idPractitioner.meta Short descriptionMetadata 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.
Data typeMeta Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPractitioner.implicitRules Short descriptionA set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
CommentsAsserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Data typeuri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.language Short descriptionLanguage of the resource content DefinitionThe base language in which the resource is written.
CommentsLanguage is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Data typecode BindingCommonLanguages (preferred) Binding extensionsConstraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
text | | 0..1 | Narrative | There are no (further) constraints on this element Element idPractitioner.text Short descriptionText summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
CommentsContained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Data typeNarrative Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
contained | | 0..* | Resource | There are no (further) constraints on this element Element idPractitioner.contained Short descriptionContained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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.
CommentsThis should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Data typeResource Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
identifier | S Σ | 0..* | Identifier | Element idPractitioner.identifier Short descriptionAn identifier that applies to this person in this role. DefinitionAn identifier that applies to this person in this role.
RequirementsOften, specific identities are assigned for the agent.
Data typeIdentifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.identifier
- v2: PRD-7 (or XCN.1)
- rim: ./id
- servd: ./Identifiers
|
active | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPractitioner.active Short descriptionWhether this practitioner's record is in active use DefinitionWhether this practitioner's record is in active use.
RequirementsNeed to be able to mark a practitioner record as not to be used because it was created in error.
CommentsIf the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.
Meaning when missingThis resource is generally assumed to be active if no value is provided for the active element
Data typeboolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.status
- rim: ./statusCode
|
name | S Σ | 0..* | HumanName | Element idPractitioner.name Short descriptionThe name(s) associated with the practitioner. DefinitionThe name(s) associated with the practitioner.
RequirementsThe 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.
CommentsThe selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate.
In general, select the value to be used in the ResourceReference.display based on this:
- There is more than 1 name
- Use = usual
- Period is current to the date of the usage
- Use = official
- Other order as decided by internal business rules.
Data typeHumanName Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XCN Components
- rim: ./name
- servd: ./PreferredName (GivenNames, FamilyName, TitleCode)
|
telecom | S Σ | 0..* | ContactPoint | Element idPractitioner.telecom Short descriptionA 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.
RequirementsNeed to know how to reach a practitioner independent to any roles the practitioner may have.
CommentsPerson may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.
Data typeContactPoint Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: PRT-15, STF-10, ROL-12
- rim: ./telecom
- servd: ./ContactPoints
|
address | Σ | 0..* | Address | There are no (further) constraints on this element Element idPractitioner.address Short descriptionAddress(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.
RequirementsThe 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.
CommentsThe PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).
Data typeAddress Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: ORC-24, STF-11, ROL-11, PRT-14
- rim: ./addr
- servd: ./Addresses
|
gender | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.gender Short descriptionmale | female | other | unknown DefinitionAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
RequirementsNeeded to address the person correctly.
Data typecode BindingThe gender of a person used for administrative purposes.
AdministrativeGender (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: STF-5
- rim: ./administrativeGender
- servd: ./GenderCode
|
birthDate | Σ | 0..1 | date | There are no (further) constraints on this element Element idPractitioner.birthDate Short descriptionThe date on which the practitioner was born DefinitionThe date of birth for the practitioner.
RequirementsNeeded for identification.
Data typedate Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: STF-6
- rim: ./birthTime
- servd: (not represented in ServD)
|
photo | | 0..* | Attachment | There are no (further) constraints on this element Element idPractitioner.photo Short descriptionImage of the person DefinitionRequirementsMany EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.
Data typeAttachment Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: ./subjectOf/ObservationEvent[code="photo"]/value
- servd: ./ImageURI (only supports the URI reference)
|
qualification | | 0..* | BackboneElement | There are no (further) constraints on this element Element idPractitioner.qualification Short descriptionCertification, 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.
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: CER?
- rim: .playingEntity.playingRole[classCode=QUAL].code
- servd: ./Qualifications
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.qualification.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.qualification.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.qualification.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
identifier | | 0..* | Identifier | There are no (further) constraints on this element Element idPractitioner.qualification.identifier Short descriptionAn identifier for this qualification for the practitioner DefinitionAn identifier that applies to this person's qualification in this role.
RequirementsOften, specific identities are assigned for the qualification.
Data typeIdentifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: .playingEntity.playingRole[classCode=QUAL].id
|
code | | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idPractitioner.qualification.code Short descriptionCoded representation of the qualification DefinitionCoded representation of the qualification.
Data typeCodeableConcept BindingSpecific qualification the practitioner has to provide a service.
v2.0360.2.7 (example) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: .playingEntity.playingRole[classCode=QUAL].code
- servd: ./Qualifications.Value
|
period | | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.qualification.period Short descriptionPeriod during which the qualification is valid DefinitionPeriod during which the qualification is valid.
RequirementsQualifications are often for a limited period of time, and can be revoked.
Data typePeriod Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: .playingEntity.playingRole[classCode=QUAL].effectiveTime
- servd: ./Qualifications.StartDate and ./Qualifications.EndDate
|
issuer | | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPractitioner.qualification.issuer Short descriptionOrganization that regulates and issues the qualification DefinitionOrganization that regulates and issues the qualification.
Data typeReference(Organization) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: .playingEntity.playingRole[classCode=QUAL].scoper
|
communication | | 0..* | CodeableConceptBinding | Element idPractitioner.communication Short descriptionA language the practitioner can use in patient communication DefinitionA language the practitioner can use in patient communication.
RequirementsKnowing which language a practitioner speaks can help in facilitating communication with patients.
CommentsThe structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.
Data typeCodeableConcept BindingA ValueSet that identifies the language used by a person.
AllLanguages (required) Binding extensionsConstraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: PID-15, NK1-20, LAN-2
- rim: ./languageCommunication
- servd: ./Languages.LanguageSpokenCode
|