Specialty Patient Enrollment for Pharmacies

Resource Profile: Practitioner_Prescriber

This Practitioner profile sets the expectations for the SRxDataRequest message. It identifies the mandatory core elements, extensions, vocabularies and value sets which SHALL be present in the Practitioner as well as optional elements when using this profile.

Example

*See Practitioner_Prescriber resource in SRxDataRequest Example

Formal View of Profile Content

Note: Description of Profiles, Differentials, and Snapshots

This profile builds on the core FHIR R4 Practitioner resource. For additional information on the table definitions shown below, see the Logical Table section on the Resource Formats page.

Notes: Click the tabs below to see the different views for the profile:

The Full View shows all the base resource element information for the profile plus the Surescripts requirements.
The Hybrid View shows all the element information, but the unchanged information from the base resource is greyed out.
The Differential View only shows the changes made to the base resource (i.e., the Surescripts requirements).

Full View

Practitioner	I		Practitioner	There are no (further) constraints on this element Element Id Practitioner Short description A person with a formal responsibility in the provisioning of healthcare or related services Definition A person who is directly or indirectly involved in the provisioning of healthcare. Data Type Practitioner Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-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-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-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` Mappings rim:Entity. Role, or Act v2:PRD (as one example) rim:Role servd:Provider
identifier	S Σ	0..*	Identifier	Element Id Practitioner.identifier Short description An identifier for the person as this agent Definition An identifier that applies to this person in this role. Requirements Often, specific identities are assigned for the agent. Comments If available, the NPI of the Practitioner should be included as the identifier.value for an Identifier element for which the identifier.system is "http://hl7.org/fhir/sid/us-npi". If available, the Surescripts Provider ID (SPI) of the Practitioner should be included as the identifier.value for an Identifier element for which the identifier.system is “http://fhirdocs.surescripts.net/spi”. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier 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 Id Practitioner.active Short description Whether this practitioner's record is in active use Definition Whether this practitioner's record is in active use. Requirements Need to be able to mark a practitioner record as not to be used because it was created in error. Comments If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role. Meaning When Missing This resource is generally assumed to be active if no value is provided for the active element Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.status rim:./statusCode
name	S Σ	0..*	HumanName	There are no (further) constraints on this element Element Id Practitioner.name Short description The name(s) associated with the practitioner Definition The name(s) associated with the practitioner. Requirements The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. Comments The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this: There is more than 1 name Use = usual Period is current to the date of the usage Use = official Other order as decided by internal business rules. Data Type HumanName Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:XCN Components rim:./name servd:./PreferredName (GivenNames, FamilyName, TitleCode)
telecom	Σ I	0..*	ContactPoint	There are no (further) constraints on this element Element Id Practitioner.telecom Short description A contact detail for the practitioner (that apply to all roles) Definition A contact detail for the practitioner, e.g. a telephone number or an email address. Requirements Need to know how to reach a practitioner independent to any roles the practitioner may have. Comments Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific. Data Type ContactPoint Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:PRT-15, STF-10, ROL-12 rim:./telecom servd:./ContactPoints
address	Σ	0..*	Address	There are no (further) constraints on this element Element Id Practitioner.address Short description Address(es) of the practitioner that are not role specific (typically home address) Definition Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. Requirements The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. Comments The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address). Data Type Address Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD rim:AD servd:Address 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 Id Practitioner.gender Short description male \| female \| other \| unknown Definition Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Requirements Needed to address the person correctly. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The gender of a person used for administrative purposes. AdministrativeGender (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:STF-5 rim:./administrativeGender servd:./GenderCode
birthDate	Σ	0..1	date	There are no (further) constraints on this element Element Id Practitioner.birthDate Short description The date on which the practitioner was born Definition The date of birth for the practitioner. Requirements Needed for identification. Data Type date Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:STF-6 rim:./birthTime servd:(not represented in ServD)
photo	I	0..*	Attachment	There are no (further) constraints on this element Element Id Practitioner.photo Short description Image of the person Definition Image of the person. Requirements Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. Comments 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". Data Type Attachment Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` att-1:If the Attachment has data, it SHALL have a contentType `data.empty() or contentType.exists()` Mappings rim:n/a v2:ED/RP rim:ED rim:./subjectOf/ObservationEvent[code="photo"]/value servd:./ImageURI (only supports the URI reference)
qualification		0..*	BackboneElement	There are no (further) constraints on this element Element Id Practitioner.qualification Short description Certification, licenses, or training pertaining to the provision of care Definition The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CER? rim:.playingEntity.playingRole[classCode=QUAL].code servd:./Qualifications
identifier		0..*	Identifier	There are no (further) constraints on this element Element Id Practitioner.qualification.identifier Short description An identifier for this qualification for the practitioner Definition An identifier that applies to this person's qualification in this role. Requirements Often, specific identities are assigned for the qualification. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier rim:.playingEntity.playingRole[classCode=QUAL].id
code		1..1	CodeableConcept	There are no (further) constraints on this element Element Id Practitioner.qualification.code Short description Coded representation of the qualification Definition Coded representation of the qualification. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding Specific 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:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD rim:.playingEntity.playingRole[classCode=QUAL].code servd:./Qualifications.Value
period	I	0..1	Period	There are no (further) constraints on this element Element Id Practitioner.qualification.period Short description Period during which the qualification is valid Definition Period during which the qualification is valid. Requirements Qualifications are often for a limited period of time, and can be revoked. Comments 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. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] rim:.playingEntity.playingRole[classCode=QUAL].effectiveTime servd:./Qualifications.StartDate and ./Qualifications.EndDate
issuer	I	0..1	Reference(Organization)	There are no (further) constraints on this element Element Id Practitioner.qualification.issuer Short description Organization that regulates and issues the qualification Definition Organization that regulates and issues the qualification. Comments 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. Data Type Reference(Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim:.playingEntity.playingRole[classCode=QUAL].scoper
communication		0..*	CodeableConceptBinding	There are no (further) constraints on this element Element Id Practitioner.communication Short description A language the practitioner can use in patient communication Definition A language the practitioner can use in patient communication. Requirements Knowing which language a practitioner speaks can help in facilitating communication with patients. Comments The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. Data Type CodeableConcept Binding A human language. CommonLanguages (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:PID-15, NK1-20, LAN-2 rim:./languageCommunication servd:./Languages.LanguageSpokenCode

Hybrid View

Practitioner	I		Practitioner	There are no (further) constraints on this element Element Id Practitioner Short description A person with a formal responsibility in the provisioning of healthcare or related services Definition A person who is directly or indirectly involved in the provisioning of healthcare. Data Type Practitioner Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-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-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-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` Mappings rim:Entity. Role, or Act v2:PRD (as one example) rim:Role servd:Provider
identifier	S Σ	0..*	Identifier	Element Id Practitioner.identifier Short description An identifier for the person as this agent Definition An identifier that applies to this person in this role. Requirements Often, specific identities are assigned for the agent. Comments If available, the NPI of the Practitioner should be included as the identifier.value for an Identifier element for which the identifier.system is "http://hl7.org/fhir/sid/us-npi". If available, the Surescripts Provider ID (SPI) of the Practitioner should be included as the identifier.value for an Identifier element for which the identifier.system is “http://fhirdocs.surescripts.net/spi”. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier 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 Id Practitioner.active Short description Whether this practitioner's record is in active use Definition Whether this practitioner's record is in active use. Requirements Need to be able to mark a practitioner record as not to be used because it was created in error. Comments If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role. Meaning When Missing This resource is generally assumed to be active if no value is provided for the active element Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.status rim:./statusCode
name	S Σ	0..*	HumanName	There are no (further) constraints on this element Element Id Practitioner.name Short description The name(s) associated with the practitioner Definition The name(s) associated with the practitioner. Requirements The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. Comments The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this: There is more than 1 name Use = usual Period is current to the date of the usage Use = official Other order as decided by internal business rules. Data Type HumanName Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:XCN Components rim:./name servd:./PreferredName (GivenNames, FamilyName, TitleCode)
telecom	Σ I	0..*	ContactPoint	There are no (further) constraints on this element Element Id Practitioner.telecom Short description A contact detail for the practitioner (that apply to all roles) Definition A contact detail for the practitioner, e.g. a telephone number or an email address. Requirements Need to know how to reach a practitioner independent to any roles the practitioner may have. Comments Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific. Data Type ContactPoint Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:PRT-15, STF-10, ROL-12 rim:./telecom servd:./ContactPoints
address	Σ	0..*	Address	There are no (further) constraints on this element Element Id Practitioner.address Short description Address(es) of the practitioner that are not role specific (typically home address) Definition Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. Requirements The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. Comments The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address). Data Type Address Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD rim:AD servd:Address 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 Id Practitioner.gender Short description male \| female \| other \| unknown Definition Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Requirements Needed to address the person correctly. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The gender of a person used for administrative purposes. AdministrativeGender (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:STF-5 rim:./administrativeGender servd:./GenderCode
birthDate	Σ	0..1	date	There are no (further) constraints on this element Element Id Practitioner.birthDate Short description The date on which the practitioner was born Definition The date of birth for the practitioner. Requirements Needed for identification. Data Type date Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:STF-6 rim:./birthTime servd:(not represented in ServD)
photo	I	0..*	Attachment	There are no (further) constraints on this element Element Id Practitioner.photo Short description Image of the person Definition Image of the person. Requirements Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. Comments 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". Data Type Attachment Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` att-1:If the Attachment has data, it SHALL have a contentType `data.empty() or contentType.exists()` Mappings rim:n/a v2:ED/RP rim:ED rim:./subjectOf/ObservationEvent[code="photo"]/value servd:./ImageURI (only supports the URI reference)
qualification		0..*	BackboneElement	There are no (further) constraints on this element Element Id Practitioner.qualification Short description Certification, licenses, or training pertaining to the provision of care Definition The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CER? rim:.playingEntity.playingRole[classCode=QUAL].code servd:./Qualifications
identifier		0..*	Identifier	There are no (further) constraints on this element Element Id Practitioner.qualification.identifier Short description An identifier for this qualification for the practitioner Definition An identifier that applies to this person's qualification in this role. Requirements Often, specific identities are assigned for the qualification. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier rim:.playingEntity.playingRole[classCode=QUAL].id
code		1..1	CodeableConcept	There are no (further) constraints on this element Element Id Practitioner.qualification.code Short description Coded representation of the qualification Definition Coded representation of the qualification. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding Specific 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:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD rim:.playingEntity.playingRole[classCode=QUAL].code servd:./Qualifications.Value
period	I	0..1	Period	There are no (further) constraints on this element Element Id Practitioner.qualification.period Short description Period during which the qualification is valid Definition Period during which the qualification is valid. Requirements Qualifications are often for a limited period of time, and can be revoked. Comments 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. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] rim:.playingEntity.playingRole[classCode=QUAL].effectiveTime servd:./Qualifications.StartDate and ./Qualifications.EndDate
issuer	I	0..1	Reference(Organization)	There are no (further) constraints on this element Element Id Practitioner.qualification.issuer Short description Organization that regulates and issues the qualification Definition Organization that regulates and issues the qualification. Comments 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. Data Type Reference(Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim:.playingEntity.playingRole[classCode=QUAL].scoper
communication		0..*	CodeableConceptBinding	There are no (further) constraints on this element Element Id Practitioner.communication Short description A language the practitioner can use in patient communication Definition A language the practitioner can use in patient communication. Requirements Knowing which language a practitioner speaks can help in facilitating communication with patients. Comments The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. Data Type CodeableConcept Binding A human language. CommonLanguages (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:PID-15, NK1-20, LAN-2 rim:./languageCommunication servd:./Languages.LanguageSpokenCode

Differential View

Practitioner	I		Practitioner	There are no (further) constraints on this element Element Id Practitioner Short description A person with a formal responsibility in the provisioning of healthcare or related services Definition A person who is directly or indirectly involved in the provisioning of healthcare. Data Type Practitioner Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-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-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-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` Mappings rim:Entity. Role, or Act v2:PRD (as one example) rim:Role servd:Provider
identifier	S Σ	0..*	Identifier	Element Id Practitioner.identifier Short description An identifier for the person as this agent Definition An identifier that applies to this person in this role. Requirements Often, specific identities are assigned for the agent. Comments If available, the NPI of the Practitioner should be included as the identifier.value for an Identifier element for which the identifier.system is "http://hl7.org/fhir/sid/us-npi". If available, the Surescripts Provider ID (SPI) of the Practitioner should be included as the identifier.value for an Identifier element for which the identifier.system is “http://fhirdocs.surescripts.net/spi”. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier 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 Id Practitioner.active Short description Whether this practitioner's record is in active use Definition Whether this practitioner's record is in active use. Requirements Need to be able to mark a practitioner record as not to be used because it was created in error. Comments If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role. Meaning When Missing This resource is generally assumed to be active if no value is provided for the active element Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.status rim:./statusCode
name	S Σ	0..*	HumanName	There are no (further) constraints on this element Element Id Practitioner.name Short description The name(s) associated with the practitioner Definition The name(s) associated with the practitioner. Requirements The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. Comments The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this: There is more than 1 name Use = usual Period is current to the date of the usage Use = official Other order as decided by internal business rules. Data Type HumanName Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:XCN Components rim:./name servd:./PreferredName (GivenNames, FamilyName, TitleCode)
telecom	Σ I	0..*	ContactPoint	There are no (further) constraints on this element Element Id Practitioner.telecom Short description A contact detail for the practitioner (that apply to all roles) Definition A contact detail for the practitioner, e.g. a telephone number or an email address. Requirements Need to know how to reach a practitioner independent to any roles the practitioner may have. Comments Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific. Data Type ContactPoint Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:PRT-15, STF-10, ROL-12 rim:./telecom servd:./ContactPoints
address	Σ	0..*	Address	There are no (further) constraints on this element Element Id Practitioner.address Short description Address(es) of the practitioner that are not role specific (typically home address) Definition Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. Requirements The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. Comments The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address). Data Type Address Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD rim:AD servd:Address 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 Id Practitioner.gender Short description male \| female \| other \| unknown Definition Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Requirements Needed to address the person correctly. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The gender of a person used for administrative purposes. AdministrativeGender (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:STF-5 rim:./administrativeGender servd:./GenderCode
birthDate	Σ	0..1	date	There are no (further) constraints on this element Element Id Practitioner.birthDate Short description The date on which the practitioner was born Definition The date of birth for the practitioner. Requirements Needed for identification. Data Type date Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:STF-6 rim:./birthTime servd:(not represented in ServD)
photo	I	0..*	Attachment	There are no (further) constraints on this element Element Id Practitioner.photo Short description Image of the person Definition Image of the person. Requirements Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. Comments 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". Data Type Attachment Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` att-1:If the Attachment has data, it SHALL have a contentType `data.empty() or contentType.exists()` Mappings rim:n/a v2:ED/RP rim:ED rim:./subjectOf/ObservationEvent[code="photo"]/value servd:./ImageURI (only supports the URI reference)
qualification		0..*	BackboneElement	There are no (further) constraints on this element Element Id Practitioner.qualification Short description Certification, licenses, or training pertaining to the provision of care Definition The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CER? rim:.playingEntity.playingRole[classCode=QUAL].code servd:./Qualifications
identifier		0..*	Identifier	There are no (further) constraints on this element Element Id Practitioner.qualification.identifier Short description An identifier for this qualification for the practitioner Definition An identifier that applies to this person's qualification in this role. Requirements Often, specific identities are assigned for the qualification. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier rim:.playingEntity.playingRole[classCode=QUAL].id
code		1..1	CodeableConcept	There are no (further) constraints on this element Element Id Practitioner.qualification.code Short description Coded representation of the qualification Definition Coded representation of the qualification. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding Specific 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:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD rim:.playingEntity.playingRole[classCode=QUAL].code servd:./Qualifications.Value
period	I	0..1	Period	There are no (further) constraints on this element Element Id Practitioner.qualification.period Short description Period during which the qualification is valid Definition Period during which the qualification is valid. Requirements Qualifications are often for a limited period of time, and can be revoked. Comments 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. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] rim:.playingEntity.playingRole[classCode=QUAL].effectiveTime servd:./Qualifications.StartDate and ./Qualifications.EndDate
issuer	I	0..1	Reference(Organization)	There are no (further) constraints on this element Element Id Practitioner.qualification.issuer Short description Organization that regulates and issues the qualification Definition Organization that regulates and issues the qualification. Comments 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. Data Type Reference(Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim:.playingEntity.playingRole[classCode=QUAL].scoper
communication		0..*	CodeableConceptBinding	There are no (further) constraints on this element Element Id Practitioner.communication Short description A language the practitioner can use in patient communication Definition A language the practitioner can use in patient communication. Requirements Knowing which language a practitioner speaks can help in facilitating communication with patients. Comments The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. Data Type CodeableConcept Binding A human language. CommonLanguages (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:PID-15, NK1-20, LAN-2 rim:./languageCommunication servd:./Languages.LanguageSpokenCode