Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the STU3 profiles here.
| Official URL: https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner | Version: 2.4.0 | |||
| Active as of 2023-12-12 | Computable Name: UKCorePractitioner | |||
Copyright/Legal: Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html. |
||||
This profile defines the UK constraints and extensions on the International FHIR resource Practitioner.
This profile allows exchange of information about all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities, is used for attribution of activities and responsibilities to these individuals.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Practitioner
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Practitioner |
Practitioner | |||
  identifier |
S | 0..* | Identifier | An identifier that applies to this person in this role. |
| name |
S | 0..* | HumanName | The name(s) associated with the practitioner. |
| telecom |
S | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles). |
 communication |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: AllLanguages (required): A ValueSet that identifies the language used by a person. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Practitioner.communication | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner |
0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier |
SΣ | 0..* | Identifier | An identifier that applies to this person in this role. |
| name |
SΣ | 0..* | HumanName | The name(s) associated with the practitioner. |
| telecom |
SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles). |
| communication |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: AllLanguages (required): A ValueSet that identifies the language used by a person. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Practitioner.communication | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Practitioner | 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 | error | Practitioner | 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 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner |
0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 0..* | Identifier | An identifier that applies to this person in this role. | ||||
| active |
Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
| name |
SΣ | 0..* | HumanName | The name(s) associated with the practitioner. | ||||
| telecom |
SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles). | ||||
| address |
Σ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) | ||||
| gender |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate |
Σ | 0..1 | date | The date on which the practitioner was born | ||||
| photo |
0..* | Attachment | Image of the person | |||||
 qualification |
0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
0..* | Identifier | An identifier for this qualification for the practitioner | |||||
| code |
1..1 | CodeableConcept | Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service. | |||||
| period |
0..1 | Period | Period during which the qualification is valid | |||||
 issuer |
0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
| communication |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: AllLanguages (required): A ValueSet that identifies the language used by a person. | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Practitioner.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Practitioner.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Practitioner.qualification.code | example | v2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)http://terminology.hl7.org/ValueSet/v2-2.7-0360from the FHIR Standard | ||||
| Practitioner.communication | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Practitioner | 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 | error | Practitioner | 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 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Practitioner
Differential View
This structure is derived from Practitioner
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner |
Practitioner | |||
| identifier |
S | 0..* | Identifier | An identifier that applies to this person in this role. |
| name |
S | 0..* | HumanName | The name(s) associated with the practitioner. |
| telecom |
S | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles). |
| communication |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: AllLanguages (required): A ValueSet that identifies the language used by a person. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Practitioner.communication | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner |
0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 0..* | Identifier | An identifier that applies to this person in this role. |
| name |
SΣ | 0..* | HumanName | The name(s) associated with the practitioner. |
| telecom |
SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles). |
| communication |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: AllLanguages (required): A ValueSet that identifies the language used by a person. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Practitioner.communication | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Practitioner | 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 | error | Practitioner | 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 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner |
0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 0..* | Identifier | An identifier that applies to this person in this role. | ||||
| active |
Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
| name |
SΣ | 0..* | HumanName | The name(s) associated with the practitioner. | ||||
| telecom |
SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles). | ||||
| address |
Σ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) | ||||
| gender |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate |
Σ | 0..1 | date | The date on which the practitioner was born | ||||
| photo |
0..* | Attachment | Image of the person | |||||
| qualification |
0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
0..* | Identifier | An identifier for this qualification for the practitioner | |||||
| code |
1..1 | CodeableConcept | Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service. | |||||
| period |
0..1 | Period | Period during which the qualification is valid | |||||
| issuer |
0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
| communication |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: AllLanguages (required): A ValueSet that identifies the language used by a person. | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Practitioner.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Practitioner.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Practitioner.qualification.code | example | v2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)http://terminology.hl7.org/ValueSet/v2-2.7-0360from the FHIR Standard | ||||
| Practitioner.communication | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Practitioner | 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 | error | Practitioner | 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 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Practitioner
Other representations of profile: CSV, Excel, Schematron