BCY Immunization Distribution Service Implementation Guide

PractitionerConsentGivenTo

The FHIR resource PractitionerGivenTo is to whom the client has given his/her consent to the provider. This is for Consent purpose.

PractitionerConsentGivenTo (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-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	Σ	1..1	string	Element id Practitioner.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments See Mappings Data type string Mappings source-PIR: CONSENT.CONSENT_DIRECTIVE_ID
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Practitioner.meta Short description Metadata about the resource Definition The 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 type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
id		0..1	string	There are no (further) constraints on this element Element id Practitioner.meta.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.meta.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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 rim: n/a
versionId	Σ	0..1	id	Element id Practitioner.meta.versionId Short description Version specific identifier Definition The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. Comments Apply "2025.01.1". This indicates the FHIR specs as of year 2025 Jan Data type id Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
lastUpdated	Σ	0..1	instant	Element id Practitioner.meta.lastUpdated Short description When the resource version last changed Definition When the resource last changed - e.g. when the version changed. Comments Updated: Relax the previously crossed-out elements. Data type instant Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
source	Σ	0..1	uri	There are no (further) constraints on this element Element id Practitioner.meta.source Short description Identifies where the resource comes from Definition A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. Comments In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
profile	Σ	1..1	canonical(StructureDefinition)	Element id Practitioner.meta.profile Short description Profiles this resource claims to conform to Definition A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. Comments Apply "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/PractitionerConsentGivenTo" Data type canonical(StructureDefinition) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
security	Σ	0..1	CodingBinding	There are no (further) constraints on this element Element id Practitioner.meta.security Short description Security Labels applied to this resource Definition Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. Comments The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Data type Coding Binding Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
tag	Σ	0..1	Coding	There are no (further) constraints on this element Element id Practitioner.meta.tag Short description Tags applied to this resource Definition Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. Comments The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Data type Coding Binding Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". CommonTags (example) 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 id Practitioner.implicitRules Short description A set of rules under which this content was created 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. 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. 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 type uri 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 id Practitioner.language Short description Language of the resource content Definition The base language in which the resource is written. 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). Data type code Binding A human language. CommonLanguages (preferred) Constraints 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 id Practitioner.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A 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. Comments Contained 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 type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..1	Resource	There are no (further) constraints on this element Element id Practitioner.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources 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. 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data type Extension 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 rim: N/A
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content 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 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). Requirements Modifier 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. 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. Data type Extension 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 rim: N/A
identifier	Σ	0..1	Identifier	There are no (further) constraints on this element 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. Data type Identifier 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 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 w5: FiveWs.status rim: ./statusCode
name	Σ	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 v2: XCN Components rim: ./name servd: ./PreferredName (GivenNames, FamilyName, TitleCode)
id		0..1	string	There are no (further) constraints on this element Element id Practitioner.name.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.name.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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 rim: n/a
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id Practitioner.name.use Short description usual \| official \| temp \| nickname \| anonymous \| old \| maiden Definition Identifies the purpose for this name. Requirements Allows the appropriate name for a particular context of use to be selected from among a set of names. Comments Applications can assume that a name is current unless it explicitly says that it is temporary or old. Data type code Binding The use of a human name. NameUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XPN.7, but often indicated by which field contains the name rim: unique(./use) servd: ./NamePurpose
text	Σ	0..1	string	There are no (further) constraints on this element Element id Practitioner.name.text Short description Text representation of the full name Definition Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. Requirements A renderable, unencoded form. Comments Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: implied by XPN.11 rim: ./formatted
family	Σ	1..1	string	Element id Practitioner.name.family Short description Family name (often called 'Surname') Alternate names surname Definition The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. Comments See Mappings Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XPN.1/FN.1 rim: ./part[partType = FAM] servd: ./FamilyName source-PIR-name: CONSENT.CONSENT_OBTAINED_BY source-PIR-NotSpecified: Not Specified
given	Σ	1..1	string	Element id Practitioner.name.given Short description Given names (not always 'first'). Includes middle names Alternate names first name, middle name Definition Given name. Comments FIRST Name sends in first place of Given Name, MIDDLE Name sneds in second place of Given Name. If Not Specified, sends "Not Specified". Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XPN.2 + XPN.3 rim: ./part[partType = GIV] servd: ./GivenNames
prefix	Σ	0..1	string	There are no (further) constraints on this element Element id Practitioner.name.prefix Short description Parts that come before the name Definition Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XPN.5 rim: ./part[partType = PFX] servd: ./TitleCode
suffix	Σ	0..1	string	There are no (further) constraints on this element Element id Practitioner.name.suffix Short description Parts that come after the name Definition Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XPN/4 rim: ./part[partType = SFX]
period	Σ	0..1	Period	There are no (further) constraints on this element Element id Practitioner.name.period Short description Time period when name was/is in use Definition Indicates the period of time when this name was valid for the named person. Requirements Allows names to be placed in historical context. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XPN.13 + XPN.14 rim: ./usablePeriod[type="IVL<TS>"] servd: ./StartDate and ./EndDate
telecom	Σ	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())` Mappings 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 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. 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 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 v2: STF-6 rim: ./birthTime servd: (not represented in ServD)
photo		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. Data type Attachment 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 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 v2: CER? rim: .playingEntity.playingRole[classCode=QUAL].code servd: ./Qualifications
id		0..1	string	There are no (further) constraints on this element Element id Practitioner.qualification.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.qualification.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data type Extension 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 rim: n/a
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.qualification.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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 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). Requirements Modifier 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. 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. Data type Extension 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 rim: N/A
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: .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. 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: .playingEntity.playingRole[classCode=QUAL].code servd: ./Qualifications.Value
period		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. Data type Period 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 id Practitioner.qualification.issuer Short description Organization that regulates and issues the qualification Definition Organization that regulates and issues the qualification. Data type Reference(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	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 v2: PID-15, NK1-20, LAN-2 rim: ./languageCommunication servd: ./Languages.LanguageSpokenCode

Practitioner
Definition	A person who is directly or indirectly involved in the provisioning of healthcare.
Cardinality	0...*
Invariants	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
Practitioner.id
Definition	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality	1...1
Type	string
Summary	True
Comments	See Mappings
Mappings	source-PIR: CONSENT.CONSENT_DIRECTIVE_ID
Practitioner.meta
Definition	The 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.
Cardinality	0...1
Type	Meta
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Practitioner.meta.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
Practitioner.meta.extension
Definition	May 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.
Cardinality	0...*
Type	Extension
Alias	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	Unordered, Open, by url(Value)
Invariants	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	rim: n/a
Practitioner.meta.versionId
Definition	The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
Cardinality	0...1
Type	id
Summary	True
Comments	Apply "2025.01.1". This indicates the FHIR specs as of year 2025 Jan
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Practitioner.meta.lastUpdated
Definition	When the resource last changed - e.g. when the version changed.
Cardinality	0...1
Type	instant
Summary	True
Comments	Updated: Relax the previously crossed-out elements.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Practitioner.meta.source
Definition	A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
Cardinality	0...1
Type	uri
Summary	True
Comments	In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Practitioner.meta.profile
Definition	A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url).
Cardinality	1...1
Type	canonical(StructureDefinition)
Summary	True
Comments	Apply "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/PractitionerConsentGivenTo"
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Practitioner.meta.security
Definition	Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Cardinality	0...1
Type	Coding
Binding	Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible)
Summary	True
Comments	The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Practitioner.meta.tag
Definition	Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
Cardinality	0...1
Type	Coding
Binding	Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". CommonTags (example)
Summary	True
Comments	The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality	0...1
Type	uri
Modifier	True
Summary	True
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. 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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Practitioner.language
Definition	The base language in which the resource is written.
Cardinality	0...1
Type	code
Binding	A human language. CommonLanguages (preferred)
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).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Practitioner.text
Definition	A 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.
Cardinality	0...1
Type	Narrative
Alias	narrative, html, xhtml, display
Comments	Contained 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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: Act.text?
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.
Cardinality	0...1
Type	Resource
Alias	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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Mappings	rim: N/A
Practitioner.extension
Definition	May 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.
Cardinality	0...*
Type	Extension
Alias	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.
Invariants	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	rim: N/A
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 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).
Cardinality	0...*
Type	Extension
Modifier	True
Alias	extensions, user content
Requirements	Modifier 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.
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.
Invariants	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	rim: N/A
Practitioner.identifier
Definition	An identifier that applies to this person in this role.
Cardinality	0...1
Type	Identifier
Summary	True
Requirements	Often, specific identities are assigned for the agent.
Invariants	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
Practitioner.active
Definition	Whether this practitioner's record is in active use.
Cardinality	0...1
Type	boolean
Summary	True
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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.status rim: ./statusCode
Practitioner.name
Definition	The name(s) associated with the practitioner.
Cardinality	0...*
Type	HumanName
Summary	True
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.
Invariants	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)
Practitioner.name.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
Practitioner.name.extension
Definition	May 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.
Cardinality	0...*
Type	Extension
Alias	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	Unordered, Open, by url(Value)
Invariants	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	rim: n/a
Practitioner.name.use
Definition	Identifies the purpose for this name.
Cardinality	0...1
Type	code
Binding	The use of a human name. NameUse (required)
Modifier	True
Summary	True
Requirements	Allows the appropriate name for a particular context of use to be selected from among a set of names.
Comments	Applications can assume that a name is current unless it explicitly says that it is temporary or old.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: XPN.7, but often indicated by which field contains the name rim: unique(./use) servd: ./NamePurpose
Practitioner.name.text
Definition	Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.
Cardinality	0...1
Type	string
Summary	True
Requirements	A renderable, unencoded form.
Comments	Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: implied by XPN.11 rim: ./formatted
Practitioner.name.family
Definition	The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
Cardinality	1...1
Type	string
Summary	True
Alias	surname
Comments	See Mappings
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: XPN.1/FN.1 rim: ./part[partType = FAM] servd: ./FamilyName source-PIR-name: CONSENT.CONSENT_OBTAINED_BY source-PIR-NotSpecified: Not Specified
Practitioner.name.given
Definition	Given name.
Cardinality	1...1
Type	string
Summary	True
Alias	first name, middle name
Comments	FIRST Name sends in first place of Given Name, MIDDLE Name sneds in second place of Given Name. If Not Specified, sends "Not Specified".
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: XPN.2 + XPN.3 rim: ./part[partType = GIV] servd: ./GivenNames
Practitioner.name.prefix
Definition	Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
Cardinality	0...1
Type	string
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: XPN.5 rim: ./part[partType = PFX] servd: ./TitleCode
Practitioner.name.suffix
Definition	Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
Cardinality	0...1
Type	string
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: XPN/4 rim: ./part[partType = SFX]
Practitioner.name.period
Definition	Indicates the period of time when this name was valid for the named person.
Cardinality	0...1
Type	Period
Summary	True
Requirements	Allows names to be placed in historical context.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: XPN.13 + XPN.14 rim: ./usablePeriod[type="IVL<TS>"] servd: ./StartDate and ./EndDate
Practitioner.telecom
Definition	A contact detail for the practitioner, e.g. a telephone number or an email address.
Cardinality	0...*
Type	ContactPoint
Summary	True
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.
Invariants	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
Practitioner.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.
Cardinality	0...*
Type	Address
Summary	True
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).
Invariants	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
Practitioner.gender
Definition	Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
Cardinality	0...1
Type	code
Binding	The gender of a person used for administrative purposes. AdministrativeGender (required)
Summary	True
Requirements	Needed to address the person correctly.
Invariants	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
Practitioner.birthDate
Definition	The date of birth for the practitioner.
Cardinality	0...1
Type	date
Summary	True
Requirements	Needed for identification.
Invariants	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)
Practitioner.photo
Definition	Image of the person.
Cardinality	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.
Invariants	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)
Practitioner.qualification
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.
Cardinality	0...*
Type	BackboneElement
Invariants	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
Practitioner.qualification.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
Practitioner.qualification.extension
Definition	May 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.
Cardinality	0...*
Type	Extension
Alias	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.
Invariants	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	rim: n/a
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 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).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier 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.
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.
Invariants	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	rim: N/A
Practitioner.qualification.identifier
Definition	An identifier that applies to this person's qualification in this role.
Cardinality	0...*
Type	Identifier
Requirements	Often, specific identities are assigned for the qualification.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .playingEntity.playingRole[classCode=QUAL].id
Practitioner.qualification.code
Definition	Coded representation of the qualification.
Cardinality	1...1
Type	CodeableConcept
Binding	Specific qualification the practitioner has to provide a service. v2.0360.2.7 (example)
Invariants	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
Practitioner.qualification.period
Definition	Period during which the qualification is valid.
Cardinality	0...1
Type	Period
Requirements	Qualifications are often for a limited period of time, and can be revoked.
Invariants	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
Practitioner.qualification.issuer
Definition	Organization that regulates and issues the qualification.
Cardinality	0...1
Type	Reference(Organization)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .playingEntity.playingRole[classCode=QUAL].scoper
Practitioner.communication
Definition	A language the practitioner can use in patient communication.
Cardinality	0...*
Type	CodeableConcept
Binding	A human language. CommonLanguages (preferred)
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.
Invariants	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

<StructureDefinition xmlns="http://hl7.org/fhir">
    <url value="http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/PractitionerConsentGivenTo" />
    <name value="PractitionerConsentGivenTo" />
    <status value="draft" />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Practitioner" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Practitioner" />
    <derivation value="constraint" />
    <differential>
        <element id="Practitioner.id">
            <path value="Practitioner.id" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="CONSENT.CONSENT_DIRECTIVE_ID" />
            </mapping>
        </element>
        <element id="Practitioner.meta">
            <path value="Practitioner.meta" />
        </element>
        <element id="Practitioner.meta.versionId">
            <path value="Practitioner.meta.versionId" />
            <comment value="Apply &quot;2025.01.1&quot;.  This indicates the FHIR specs as of year 2025 Jan" />
        </element>
        <element id="Practitioner.meta.lastUpdated">
            <path value="Practitioner.meta.lastUpdated" />
            <comment value="Updated: Relax the previously crossed-out elements." />
        </element>
        <element id="Practitioner.meta.profile">
            <path value="Practitioner.meta.profile" />
            <comment value="Apply &quot;http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/PractitionerConsentGivenTo&quot;" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="Practitioner.meta.security">
            <path value="Practitioner.meta.security" />
            <max value="1" />
        </element>
        <element id="Practitioner.meta.tag">
            <path value="Practitioner.meta.tag" />
            <max value="1" />
        </element>
        <element id="Practitioner.contained">
            <path value="Practitioner.contained" />
            <max value="1" />
        </element>
        <element id="Practitioner.identifier">
            <path value="Practitioner.identifier" />
            <max value="1" />
        </element>
        <element id="Practitioner.name.family">
            <path value="Practitioner.name.family" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR-name" />
                <map value="CONSENT.CONSENT_OBTAINED_BY" />
            </mapping>
            <mapping>
                <identity value="source-PIR-NotSpecified" />
                <map value="Not Specified" />
            </mapping>
        </element>
        <element id="Practitioner.name.given">
            <path value="Practitioner.name.given" />
            <comment value="FIRST Name sends in first place of Given Name, MIDDLE Name sneds in second place of Given Name. If Not Specified, sends &quot;Not Specified&quot;." />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="Practitioner.name.prefix">
            <path value="Practitioner.name.prefix" />
            <max value="1" />
        </element>
        <element id="Practitioner.name.suffix">
            <path value="Practitioner.name.suffix" />
            <max value="1" />
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "url": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/PractitionerConsentGivenTo",
    "name": "PractitionerConsentGivenTo",
    "status": "draft",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Practitioner",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Practitioner",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Practitioner.id",
                "path": "Practitioner.id",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "CONSENT.CONSENT_DIRECTIVE_ID"
                    }
                ]
            },
            {
                "id": "Practitioner.meta",
                "path": "Practitioner.meta"
            },
            {
                "id": "Practitioner.meta.versionId",
                "path": "Practitioner.meta.versionId",
                "comment": "Apply \"2025.01.1\".  This indicates the FHIR specs as of year 2025 Jan"
            },
            {
                "id": "Practitioner.meta.lastUpdated",
                "path": "Practitioner.meta.lastUpdated",
                "comment": "Updated: Relax the previously crossed-out elements."
            },
            {
                "id": "Practitioner.meta.profile",
                "path": "Practitioner.meta.profile",
                "comment": "Apply \"http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/PractitionerConsentGivenTo\"",
                "min": 1,
                "max": "1"
            },
            {
                "id": "Practitioner.meta.security",
                "path": "Practitioner.meta.security",
                "max": "1"
            },
            {
                "id": "Practitioner.meta.tag",
                "path": "Practitioner.meta.tag",
                "max": "1"
            },
            {
                "id": "Practitioner.contained",
                "path": "Practitioner.contained",
                "max": "1"
            },
            {
                "id": "Practitioner.identifier",
                "path": "Practitioner.identifier",
                "max": "1"
            },
            {
                "id": "Practitioner.name.family",
                "path": "Practitioner.name.family",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR-name",
                        "map": "CONSENT.CONSENT_OBTAINED_BY"
                    },
                    {
                        "identity": "source-PIR-NotSpecified",
                        "map": "Not Specified"
                    }
                ]
            },
            {
                "id": "Practitioner.name.given",
                "path": "Practitioner.name.given",
                "comment": "FIRST Name sends in first place of Given Name, MIDDLE Name sneds in second place of Given Name. If Not Specified, sends \"Not Specified\".",
                "min": 1,
                "max": "1"
            },
            {
                "id": "Practitioner.name.prefix",
                "path": "Practitioner.name.prefix",
                "max": "1"
            },
            {
                "id": "Practitioner.name.suffix",
                "path": "Practitioner.name.suffix",
                "max": "1"
            }
        ]
    }
}