VPImplementationGuide - Local Development build (v0.1.0). See the Directory of published versions
Resource Profile: Practitioner
| Official URL: https://fhir-vaccination-pass.github.io/fhir-implementation-guide/StructureDefinition/vp-practitioner | Version: 0.1.0 | |||
| Active as of 2022-08-23 | Computable Name: VPPractitioner | |||
Practitioner profile for use in FHIR Vaccination Pass
Usage:
- Refer to this Resource Profile:
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Practitioner
Summary
Mandatory: 5 elements (1 nested mandatory element)
Must-Support: 8 elements
Slices
This structure defines the following Slices:
- The element Practitioner.name is sliced based on the value of value:use (Closed)
This structure is derived from Practitioner
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Practitioner | 0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
  id | S | 0..1 | string | Logical id of this artifact |
  Slices for name | S | 1..* | HumanName | The name(s) associated with the practitioner Slice: Unordered, Closed by value:use |
   name:officialName | S | 1..1 | HumanName | The name(s) associated with the practitioner |
  use | S | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Required Pattern: official |
| family | S | 1..1 | string | Family name (often called 'Surname') |
 given | S | 1..* | string | Given names (not always 'first'). Includes middle names |
 name:@default | S | 0..* | HumanName | The name(s) associated with the practitioner |
| use | S | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner | 0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |||||
 id | SΣ | 0..1 | string | 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 | Σ | 0..* | Identifier | An identifier for the person as this agent | ||||
| active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
 Slices for name | SΣ | 1..* | HumanName | The name(s) associated with the practitioner Slice: Unordered, Closed by value:use | ||||
 name:officialName | SΣ | 1..1 | HumanName | The name(s) associated with the practitioner | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!SΣ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official | ||||
| text | Σ | 0..1 | string | Text representation of the full name | ||||
| family | SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
| given | SΣ | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| name:@default | SΣ | 0..* | HumanName | The name(s) associated with the practitioner | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!SΣ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
| text | Σ | 0..1 | string | Text representation of the full name | ||||
| family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
| given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| telecom | Σ | 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: CommonLanguages (preferred): A human language.
| |||||
| Documentation for this format | ||||||||
| 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 | string | Logical id of this artifact |
| Slices for name | Σ | 1..* | HumanName | The name(s) associated with the practitioner Slice: Unordered, Closed by value:use |
| name:officialName | Σ | 1..1 | HumanName | The name(s) associated with the practitioner |
| use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official |
| family | Σ | 1..1 | string | Family name (often called 'Surname') |
| given | Σ | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
| name:@default | Σ | 0..* | HumanName | The name(s) associated with the practitioner |
| use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
| Documentation for this format | ||||
This structure is derived from Practitioner
Summary
Mandatory: 5 elements (1 nested mandatory element)
Must-Support: 8 elements
Slices
This structure defines the following Slices:
- The element Practitioner.name is sliced based on the value of value:use (Closed)
Differential View
This structure is derived from Practitioner
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | 0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
| id | S | 0..1 | string | Logical id of this artifact |
| Slices for name | S | 1..* | HumanName | The name(s) associated with the practitioner Slice: Unordered, Closed by value:use |
| name:officialName | S | 1..1 | HumanName | The name(s) associated with the practitioner |
| use | S | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Required Pattern: official |
| family | S | 1..1 | string | Family name (often called 'Surname') |
| given | S | 1..* | string | Given names (not always 'first'). Includes middle names |
| name:@default | S | 0..* | HumanName | The name(s) associated with the practitioner |
| use | S | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden |
| Documentation for this format | ||||
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 | SΣ | 0..1 | string | 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 | Σ | 0..* | Identifier | An identifier for the person as this agent | ||||
| active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
| Slices for name | SΣ | 1..* | HumanName | The name(s) associated with the practitioner Slice: Unordered, Closed by value:use | ||||
| name:officialName | SΣ | 1..1 | HumanName | The name(s) associated with the practitioner | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!SΣ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official | ||||
| text | Σ | 0..1 | string | Text representation of the full name | ||||
| family | SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
| given | SΣ | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| name:@default | SΣ | 0..* | HumanName | The name(s) associated with the practitioner | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!SΣ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
| text | Σ | 0..1 | string | Text representation of the full name | ||||
| family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
| given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| telecom | Σ | 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: CommonLanguages (preferred): A human language.
| |||||
| Documentation for this format | ||||||||
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Conformance | ValueSet / Code |
| Practitioner.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Practitioner.name:officialName.use | required | Pattern: official |
| Practitioner.name:@default.use | required | NameUse |
| Practitioner.gender | required | AdministrativeGender |
| Practitioner.qualification.code | example | v2.0360.2.7 |
| Practitioner.communication | preferred | CommonLanguages Max Binding: AllLanguages |
Constraints
| Id | Grade | Path | 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 | Practitioner.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Practitioner.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Practitioner.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Practitioner.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Practitioner.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.active | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.name:officialName | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.name:officialName.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Practitioner.name:officialName.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Practitioner.name:officialName.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.name:officialName.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.name:officialName.family | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.name:officialName.given | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.name:officialName.prefix | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.name:officialName.suffix | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.name:officialName.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.name:@default | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.name:@default.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Practitioner.name:@default.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Practitioner.name:@default.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.name:@default.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.name:@default.family | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.name:@default.given | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.name:@default.prefix | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.name:@default.suffix | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.name:@default.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.gender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.birthDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.photo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.qualification | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.qualification.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Practitioner.qualification.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Practitioner.qualification.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Practitioner.qualification.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Practitioner.qualification.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.qualification.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.qualification.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.qualification.issuer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Practitioner.communication | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |