Practitioner
General information
See HL7 Practitioner for general information regarding the Practitioner resource.
Scope and Usage
This profile is used for individuals working or with the qualification to work in the healthcare and social services sector. Competencies, licenses and other qualifications are expressed in the qualification element.
Extensions for being able to express address lines as well as country in a structured way have been provided in the Address profile, as profiled by the European base profiles.
This guide defines a profile for HumanName that includes the nameQualifier extension on the name.given element. It can be used to mark the supplied given name(s) as what the patient is called by, as well as a middleName extension.
Boundaries and Relationships
Note that the Practitioner resource does not contain a connection to the workplace of the practitioner. It is used for expressing information irrelevant of workplace. Hence the telecom element should only be used for the practitioner's contact information that is not organization dependent. For use cases where this relationship is needed, the PractitionerRole resource should be used.
Background and Context
An individual with a license to perform healthcare related tasks can do so without being currently employed at a healthcare provider. Since the license, along with other qualifications and comptencies, belong to the individual, it is necessary to distinguish the practitioner from any employments the practitioner might have. A Practitioner should be interpreted as a person that can have qualifications. The PractitionerRole profile should be used to express a position the practitioner holds or has held as an employee at a certain healthcare provider.
Profile
| NPPRPractitioner (Practitioner) | C | Practitioner | |
| id | Σ | 0..1 | id |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | C | 0..1 | Narrative |
| contained | C | 0..* | Resource |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| identifier | S Σ C | 1..1 | Identifier |
| (All Slices) | |||
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | S Σ | 1..1 | uri |
| value | S Σ C | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| personalIdentityNumber | S Σ C | 0..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | S Σ | 1..1 | uriFixed Value |
| value | S Σ C | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| active | Σ ?! | 0..1 | boolean |
| name | S Σ | 1..1 | NPPRHumanName |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| middleName | S C | 0..1 | Extension(string) |
| use | Σ ?! | 0..1 | codeBinding |
| text | S Σ | 0..1 | string |
| family | S Σ | 1..1 | string |
| given | S Σ | 1..* | string |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| nameQualifier | S C | 0..1 | Extension(code) |
| value | 0..1 | System.String | |
| prefix | Σ | 0..* | string |
| suffix | Σ | 0..* | string |
| period | Σ C | 0..1 | Period |
| telecom | S Σ C | 0..* | NPPRContactPoint |
| gender | Σ | 0..1 | codeBinding |
| birthDate | Σ | 0..1 | date |
| deceased[x] | Σ | 0..1 | |
| deceasedBoolean | boolean | ||
| deceasedDateTime | dateTime | ||
| address | S Σ | 0..* | NPPRAddress |
| id | 0..1 | string | |
| extension | C | 1..* | Extension |
| officialAddressType | S C | 1..1 | Extension(CodeableConcept) |
| use | S Σ ?! | 0..1 | codeBinding |
| type | S Σ | 0..1 | codeBinding |
| text | Σ | 0..1 | string |
| line | S Σ | 0..* | string |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| streetName | S C | 0..1 | Extension(string) |
| houseNumber | S C | 0..1 | Extension(string) |
| postBox | S C | 0..1 | Extension(string) |
| value | S | 0..1 | System.String |
| city | S Σ | 0..1 | string |
| district | Σ | 0..1 | string |
| state | Σ | 0..1 | string |
| postalCode | S Σ | 0..1 | string |
| country | S Σ | 0..1 | string |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| countryCode | S C | 0..1 | Extension(Coding) |
| id | 0..1 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | C | 1..1 | Binding |
| valueCoding | Coding | ||
| value | 0..1 | System.String | |
| period | S Σ C | 1..1 | Period |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| start | S Σ C | 1..1 | dateTime |
| end | S Σ C | 0..1 | dateTime |
| photo | C | 0..* | Attachment |
| qualification | S | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| identifier | S C | 0..* | Identifier |
| (All Slices) | |||
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | S Σ | 1..1 | uri |
| value | S Σ C | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| prescriber | S C | 0..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | S Σ | 1..1 | uriFixed Value |
| value | S Σ C | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| legitimation | S C | 0..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | S Σ | 1..1 | uriFixed Value |
| value | S Σ C | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| code | S | 1..1 | CodeableConcept |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | S Σ C | 1..1 | Coding |
| (All Slices) | |||
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uri |
| version | Σ | 0..1 | string |
| code | S Σ C | 1..1 | code |
| display | Σ C | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| healthcareProfessionalLicense | S Σ C | 0..1 | CodingBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uriPattern |
| version | Σ | 0..1 | string |
| code | S Σ C | 1..1 | code |
| display | Σ C | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| period | S C | 1..1 | Period |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| start | S Σ C | 1..1 | dateTime |
| end | S Σ C | 0..1 | dateTime |
| issuer | C | 0..1 | Reference(Organization) |
| communication | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| language | 1..1 | CodeableConceptBinding | |
| preferred | 0..1 | boolean |
| Practitioner | |
| Short | 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 or related services. |
| Cardinality | 0..* |
| Constraints |
|
| Mappings |
|
| Practitioner.id | |
| Short | 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. |
| Cardinality | 0..1 |
| Type | id |
| Summary | True |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| Constraints |
|
| Mappings |
|
| Practitioner.meta | |
| Short | 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. |
| Cardinality | 0..1 |
| Type | Meta |
| Summary | True |
| Constraints |
|
| Mappings |
|
| Practitioner.implicitRules | |
| Short | 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. |
| 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 its narrative along with other profiles, value sets, etc. |
| Constraints |
|
| Mappings |
|
| Practitioner.language | |
| Short | Language of the resource content |
| Definition | The base language in which the resource is written. |
| Cardinality | 0..1 |
| Type | code |
| Binding | IETF language tag for a human language |
| 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). |
| Constraints |
|
| Mappings |
|
| Practitioner.text | |
| Short | Text summary of the resource, for human interpretation |
| 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 a 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: dom-6 |
| Constraints |
|
| Mappings |
|
| Practitioner.contained | |
| Short | Contained, inline Resources |
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| Cardinality | 0..* |
| 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5 |
| Mappings |
|
| Practitioner.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Practitioner.modifierExtension | |
| Short | Extensions that cannot be ignored |
| 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 managable, 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 |
| Summary | 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. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Practitioner.identifier | |
| Short | An identifier for the person as this agent |
| Definition | An identifier that applies to this person in this role. |
| Cardinality | 1..1 |
| Type | Identifier |
| Must Support | True |
| Summary | True |
| Requirements | Often, specific identities are assigned for the agent. |
| Comments | The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension. |
| Slicing | Unordered, Open, by system(Value) Slice identifier based on the system value |
| Constraints |
|
| Mappings |
|
| Practitioner.identifier.id | |
| Short | 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. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Practitioner.identifier.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Practitioner.identifier.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..1 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| Practitioner.identifier.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..1 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Constraints |
|
| Mappings |
|
| Practitioner.identifier.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Must Support | True |
| Summary | True |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| Practitioner.identifier.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Must Support | True |
| Summary | True |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| Practitioner.identifier.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..1 |
| Type | Period |
| Summary | True |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Mappings |
|
| Practitioner.identifier.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..1 |
| Type | Reference(Organization) |
| Summary | True |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Constraints |
|
| Mappings |
|
| Practitioner.identifier:personalIdentityNumber | |
| Short | An identifier for the person as this agent |
| Definition | An identifier that applies to this person in this role. |
| Cardinality | 0..1 |
| Type | Identifier |
| Must Support | True |
| Summary | True |
| Requirements | Often, specific identities are assigned for the agent. |
| Comments | The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension. |
| Constraints |
|
| Mappings |
|
| Practitioner.identifier:personalIdentityNumber.id | |
| Short | 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. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Practitioner.identifier:personalIdentityNumber.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Practitioner.identifier:personalIdentityNumber.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..1 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| Practitioner.identifier:personalIdentityNumber.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..1 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Constraints |
|
| Mappings |
|
| Practitioner.identifier:personalIdentityNumber.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Must Support | True |
| Summary | True |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Fixed Value | http://electronichealth.se/identifier/personnummer |
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| Practitioner.identifier:personalIdentityNumber.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Must Support | True |
| Summary | True |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| Practitioner.identifier:personalIdentityNumber.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..1 |
| Type | Period |
| Summary | True |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Mappings |
|
| Practitioner.identifier:personalIdentityNumber.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..1 |
| Type | Reference(Organization) |
| Summary | True |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Constraints |
|
| Mappings |
|
| Practitioner.active | |
| Short | Whether this practitioner's record is in active use |
| Definition | Whether this practitioner's record is in active use. |
| Cardinality | 0..1 |
| Type | boolean |
| Modifier | True |
| 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. |
| Meaning when missing | This resource is generally assumed to be active if no value is provided for the active element |
| Constraints |
|
| Mappings |
|
| Practitioner.name | |
| Short | Name of a human or other living entity - parts and usage |
| Definition | A name, normally of a human, that can be used for other living entities (e.g. animals but not organizations) that have been assigned names by a human and may need the use of name parts or the need for usage information. |
| Cardinality | 1..1 |
| Type | NPPRHumanName |
| Must Support | True |
| 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 | Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. |
| Constraints |
|
| Mappings |
|
| Practitioner.name.id | |
| Short | 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. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Practitioner.name.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Practitioner.name.extension:middleName | |
| Short | Optional Extensions Element |
| Definition | Extension for HumanName to express middle names. |
| Cardinality | 0..1 |
| Type | Extension(string) |
| Must Support | True |
| 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. |
| Constraints |
|
| Mappings |
|
| Practitioner.name.use | |
| Short | usual | official | temp | nickname | anonymous | old | maiden |
| Definition | Identifies the purpose for this name. |
| Cardinality | 0..1 |
| Type | code |
| Binding | The use of a human name. |
| 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. |
| Constraints |
|
| Mappings |
|
| Practitioner.name.text | |
| Short | 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. |
| Cardinality | 0..1 |
| Type | string |
| Must Support | True |
| 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. |
| Constraints |
|
| Mappings |
|
| Practitioner.name.family | |
| Short | Family name (often called '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. |
| Cardinality | 1..1 |
| Type | string |
| Must Support | True |
| Summary | True |
| Alias | surname |
| Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). |
| Constraints |
|
| Mappings |
|
| Practitioner.name.given | |
| Short | Given names (not always 'first'). Includes middle names |
| Definition | Given name. |
| Cardinality | 1..* |
| Type | string |
| Must Support | True |
| Summary | True |
| Alias | first name, middle name |
| Comments | If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. |
| Constraints |
|
| Mappings |
|
| Practitioner.name.given.id | |
| Short | 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. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Practitioner.name.given.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Practitioner.name.given.extension:nameQualifier | |
| Short | LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV |
| Definition | A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. |
| Cardinality | 0..1 |
| Type | Extension(code) |
| Must Support | True |
| Alias | extensions, user content |
| Comments | Used to indicate additional information about the name part and how it should be used. |
| Constraints |
|
| Mappings |
|
| Practitioner.name.given.value | |
| Short | Primitive value for string |
| Definition | Primitive value for string |
| Cardinality | 0..1 |
| Type | System.String |
| Maximum string length | 1048576 |
| Practitioner.name.prefix | |
| Short | 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. |
| Cardinality | 0..* |
| Type | string |
| Summary | True |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Constraints |
|
| Mappings |
|
| Practitioner.name.suffix | |
| Short | 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. |
| Cardinality | 0..* |
| Type | string |
| Summary | True |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Constraints |
|
| Mappings |
|
| Practitioner.name.period | |
| Short | Time period when name was/is in use |
| 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. |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Mappings |
|
| Practitioner.telecom | |
| Short | Details of a Technology mediated contact point (phone, fax, email, etc.) |
| Definition | Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. |
| Cardinality | 0..* |
| Type | NPPRContactPoint |
| Must Support | True |
| 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. |
| Constraints |
|
| Mappings |
|
| Practitioner.gender | |
| Short | male | female | other | unknown |
| 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. |
| Summary | True |
| Requirements | Needed to address the person correctly. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Constraints |
|
| Mappings |
|
| Practitioner.birthDate | |
| Short | The date on which the practitioner was born |
| Definition | The date of birth for the practitioner. |
| Cardinality | 0..1 |
| Type | date |
| Summary | True |
| Requirements | Needed for identification. |
| Constraints |
|
| Mappings |
|
| Practitioner.deceased[x] | |
| Short | Indicates if the practitioner is deceased or not |
| Definition | Indicates if the practitioner is deceased or not. |
| Cardinality | 0..1 |
| Type | boolean | dateTime |
| Summary | True |
| Comments | If there's no value in the instance, it means there is no statement on whether or not the practitioner is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. |
| Constraints |
|
| Mappings |
|
| Practitioner.address | |
| Short | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
| Definition | An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address. |
| Cardinality | 0..* |
| Type | NPPRAddress |
| Must Support | True |
| 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 | Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). |
| Constraints |
|
| Mappings |
|
| Practitioner.address.id | |
| Short | 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. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Practitioner.address.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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 | 1..* |
| 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) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Practitioner.address.extension:officialAddressType | |
| Short | Optional Extensions Element |
| Definition | Extension for Address to express official address type. |
| Cardinality | 1..1 |
| Type | Extension(CodeableConcept) |
| Must Support | True |
| 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. |
| Constraints |
|
| Mappings |
|
| Practitioner.address.use | |
| Short | home | work | temp | old | billing - purpose of this address |
| Definition | The purpose of this address. |
| Cardinality | 0..1 |
| Type | code |
| Binding | The use of an address (home / work / etc.). |
| Must Support | True |
| Modifier | True |
| Summary | True |
| Requirements | Allows an appropriate address to be chosen from a list of many. |
| Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
| Constraints |
|
| Examples | Generalhome |
| Mappings |
|
| Practitioner.address.type | |
| Short | postal | physical | both |
| Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
| Cardinality | 0..1 |
| Type | code |
| Binding | The type of an address (physical / postal). |
| Must Support | True |
| Summary | True |
| Comments | The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). |
| Constraints |
|
| Examples | Generalboth |
| Mappings |
|
| Practitioner.address.text | |
| Short | Text representation of the address |
| Definition | Specifies the entire address as it should be displayed e.g. on a postal label. 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 an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. |
| Constraints |
|
| Examples | General137 Nowhere Street, Erewhon 9132 |
| Mappings |
|
| Practitioner.address.line | |
| Short | Street name, number, direction & P.O. Box etc. |
| Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. |
| Cardinality | 0..* |
| Type | string |
| Must Support | True |
| Summary | True |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Constraints |
|
| Examples | General137 Nowhere Street |
| Mappings |
|
| Practitioner.address.line.id | |
| Short | 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. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Practitioner.address.line.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Practitioner.address.line.extension:streetName | |
| Short | streetName |
| Definition | streetName. |
| Cardinality | 0..1 |
| Type | Extension(string) |
| Must Support | True |
| 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. |
| Constraints |
|
| Mappings |
|
| Practitioner.address.line.extension:houseNumber | |
| Short | houseNumber |
| Definition | The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building. |
| Cardinality | 0..1 |
| Type | Extension(string) |
| Must Support | True |
| 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. |
| Constraints |
|
| Mappings |
|
| Practitioner.address.line.extension:postBox | |
| Short | postBox |
| Definition | A numbered box located in a post station. |
| Cardinality | 0..1 |
| Type | Extension(string) |
| Must Support | True |
| 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. |
| Constraints |
|
| Mappings |
|
| Practitioner.address.line.value | |
| Short | Primitive value for string |
| Definition | Primitive value for string |
| Cardinality | 0..1 |
| Type | System.String |
| Must Support | True |
| Maximum string length | 1048576 |
| Practitioner.address.city | |
| Short | Name of city, town etc. |
| Definition | The name of the city, town, suburb, village or other community or delivery center. |
| Cardinality | 0..1 |
| Type | string |
| Must Support | True |
| Summary | True |
| Alias | Municpality |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Constraints |
|
| Examples | GeneralErewhon |
| Mappings |
|
| Practitioner.address.district | |
| Short | District name (aka county) |
| Definition | The name of the administrative area (county). |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Alias | County |
| Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. |
| Constraints |
|
| Examples | GeneralMadison |
| Mappings |
|
| Practitioner.address.state | |
| Short | Sub-unit of country (abbreviations ok) |
| Definition | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Alias | Province, Territory |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Constraints |
|
| Mappings |
|
| Practitioner.address.postalCode | |
| Short | Postal code for area |
| Definition | A postal code designating a region defined by the postal service. |
| Cardinality | 0..1 |
| Type | string |
| Must Support | True |
| Summary | True |
| Alias | Zip |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Constraints |
|
| Examples | General9132 |
| Mappings |
|
| Practitioner.address.country | |
| Short | Country (e.g. may be ISO 3166 2 or 3 letter code) |
| Definition | Country - a nation as commonly understood or generally accepted. |
| Cardinality | 0..1 |
| Type | string |
| Must Support | True |
| Summary | True |
| Comments | ISO 3166 2- or 3- letter codes MAY be used in place of a human readable country name. |
| Constraints |
|
| Mappings |
|
| Practitioner.address.country.id | |
| Short | 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. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Practitioner.address.country.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Practitioner.address.country.extension:countryCode | |
| Short | code for string |
| Definition | Provides a coded expression for the content represented in a string. |
| Cardinality | 0..1 |
| Type | Extension(Coding) |
| Must Support | True |
| 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. |
| Constraints |
|
| Mappings |
|
| Practitioner.address.country.extension:countryCode.id | |
| Short | 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. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Practitioner.address.country.extension:countryCode.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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..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) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Practitioner.address.country.extension:countryCode.url | |
| Short | identifies the meaning of the extension |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Cardinality | 1..1 |
| Type | uri |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-codedString |
| Mappings |
|
| Practitioner.address.country.extension:countryCode.value[x] | |
| Short | Value of extension |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Cardinality | 1..1 |
| Type | Coding |
| Binding | A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ext-1 |
| Constraints |
|
| Mappings |
|
| Practitioner.address.country.value | |
| Short | Primitive value for string |
| Definition | Primitive value for string |
| Cardinality | 0..1 |
| Type | System.String |
| Maximum string length | 1048576 |
| Practitioner.address.period | |
| Short | Time period when address was/is in use |
| Definition | Time period when address was/is in use. |
| Cardinality | 1..1 |
| Type | Period |
| Must Support | True |
| Summary | True |
| Requirements | Allows addresses to be placed in historical context. |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Examples | General{
"start": "2010-03-23",
"end": "2010-07-01"
} |
| Mappings |
|
| Practitioner.address.period.id | |
| Short | 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. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Practitioner.address.period.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Practitioner.address.period.start | |
| Short | Starting time with inclusive boundary |
| Definition | The start of the period. The boundary is inclusive. |
| Cardinality | 1..1 |
| Type | dateTime |
| Must Support | True |
| Summary | True |
| Comments | If the low element is missing, the meaning is that the low boundary is not known. |
| Conditions | The cardinality or value of this element may be affected by these constraints: per-1 |
| Constraints |
|
| Mappings |
|
| Practitioner.address.period.end | |
| Short | End time with inclusive boundary, if not ongoing |
| Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
| Cardinality | 0..1 |
| Type | dateTime |
| Must Support | True |
| Summary | True |
| Comments | The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. |
| Meaning when missing | If the end of the period is missing, it means that the period is ongoing |
| Conditions | The cardinality or value of this element may be affected by these constraints: per-1 |
| Constraints |
|
| Mappings |
|
| Practitioner.photo | |
| Short | Image of the person |
| 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. |
| Comments | When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification | |
| Short | Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care |
| Definition | The official qualifications, certifications, accreditations, training, licenses (and other types of educations/skills/capabilities) that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board of licensure authorizing the practitioner to practice medicine within a certain locality. |
| Cardinality | 0..* |
| Type | BackboneElement |
| Must Support | True |
| Comments | The PractitionerRole.specialty defines the functional role that they are practicing at a given organization or location. Those specialties may or might not require a qualification, and are not defined on the practitioner. |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.id | |
| Short | 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. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Practitioner.qualification.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.modifierExtension | |
| Short | Extensions that cannot be ignored even if unrecognized |
| 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 managable, 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. |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.identifier | |
| Short | An identifier for this qualification for the practitioner |
| Definition | An identifier that applies to this person's qualification. |
| Cardinality | 0..* |
| Type | Identifier |
| Must Support | True |
| Requirements | Often, specific identities are assigned for the qualification. |
| Comments | The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension. |
| Slicing | Unordered, Open, by system(Value) Slice qualification.identifier based on the system value |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.identifier.id | |
| Short | 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. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Practitioner.qualification.identifier.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.identifier.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..1 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.identifier.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..1 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.identifier.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Must Support | True |
| Summary | True |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| Practitioner.qualification.identifier.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Must Support | True |
| Summary | True |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| Practitioner.qualification.identifier.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..1 |
| Type | Period |
| Summary | True |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.identifier.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..1 |
| Type | Reference(Organization) |
| Summary | True |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.identifier:prescriber | |
| Short | An identifier for this qualification for the practitioner |
| Definition | An identifier that applies to this person's qualification. |
| Cardinality | 0..1 |
| Type | Identifier |
| Must Support | True |
| Requirements | Often, specific identities are assigned for the qualification. |
| Comments | The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension. |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.identifier:prescriber.id | |
| Short | 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. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Practitioner.qualification.identifier:prescriber.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.identifier:prescriber.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..1 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.identifier:prescriber.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..1 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.identifier:prescriber.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Must Support | True |
| Summary | True |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Fixed Value | urn:oid:1.2.752.116.3.1.2 |
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| Practitioner.qualification.identifier:prescriber.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Must Support | True |
| Summary | True |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| Practitioner.qualification.identifier:prescriber.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..1 |
| Type | Period |
| Summary | True |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.identifier:prescriber.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..1 |
| Type | Reference(Organization) |
| Summary | True |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.identifier:legitimation | |
| Short | An identifier for this qualification for the practitioner |
| Definition | An identifier that applies to this person's qualification. |
| Cardinality | 0..1 |
| Type | Identifier |
| Must Support | True |
| Requirements | Often, specific identities are assigned for the qualification. |
| Comments | The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension. |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.identifier:legitimation.id | |
| Short | 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. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Practitioner.qualification.identifier:legitimation.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.identifier:legitimation.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..1 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.identifier:legitimation.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..1 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.identifier:legitimation.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Must Support | True |
| Summary | True |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Fixed Value | urn:oid:1.2.752.116.3.1.1 |
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| Practitioner.qualification.identifier:legitimation.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Must Support | True |
| Summary | True |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| Practitioner.qualification.identifier:legitimation.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..1 |
| Type | Period |
| Summary | True |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.identifier:legitimation.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..1 |
| Type | Reference(Organization) |
| Summary | True |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.code | |
| Short | Coded representation of the qualification |
| Definition | Coded representation of the qualification. |
| Cardinality | 1..1 |
| Type | CodeableConcept |
| Binding | Specific qualification the practitioner has to provide a service. |
| Must Support | True |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.code.id | |
| Short | 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. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Practitioner.qualification.code.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.code.coding | |
| Short | Code defined by a terminology system |
| Definition | A reference to a code defined by a terminology system. |
| Cardinality | 1..1 |
| Type | Coding |
| Must Support | True |
| Summary | True |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Slicing | Unordered, Open, by system(Value) Slice qualification.code based on the system value |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.code.coding.id | |
| Short | 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. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Practitioner.qualification.code.coding.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.code.coding.system | |
| Short | Identity of the terminology system |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Cardinality | 1..1 |
| Type | uri |
| Must Support | True |
| Summary | True |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.code.coding.version | |
| Short | Version of the system - if relevant |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.code.coding.code | |
| Short | Symbol in syntax defined by the system |
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| Cardinality | 1..1 |
| Type | code |
| Must Support | True |
| Summary | True |
| Requirements | Need to refer to a particular code in the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.code.coding.display | |
| Short | Representation defined by the system |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.code.coding.userSelected | |
| Short | If this coding was chosen directly by the user |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
| Cardinality | 0..1 |
| Type | boolean |
| Summary | True |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.code.coding:healthcareProfessionalLicense | |
| Short | Code defined by a terminology system |
| Definition | A reference to a code defined by a terminology system. |
| Cardinality | 0..1 |
| Type | Coding |
| Binding | |
| Must Support | True |
| Summary | True |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.code.coding:healthcareProfessionalLicense.id | |
| Short | 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. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Practitioner.qualification.code.coding:healthcareProfessionalLicense.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.code.coding:healthcareProfessionalLicense.system | |
| Short | Identity of the terminology system |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Cardinality | 1..1 |
| Type | uri |
| Must Support | True |
| Summary | True |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Constraints |
|
| Pattern | urn:oid:1.2.752.116.3.1.3 |
| Mappings |
|
| Practitioner.qualification.code.coding:healthcareProfessionalLicense.version | |
| Short | Version of the system - if relevant |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.code.coding:healthcareProfessionalLicense.code | |
| Short | Symbol in syntax defined by the system |
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| Cardinality | 1..1 |
| Type | code |
| Must Support | True |
| Summary | True |
| Requirements | Need to refer to a particular code in the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.code.coding:healthcareProfessionalLicense.display | |
| Short | Representation defined by the system |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.code.coding:healthcareProfessionalLicense.userSelected | |
| Short | If this coding was chosen directly by the user |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
| Cardinality | 0..1 |
| Type | boolean |
| Summary | True |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.code.text | |
| Short | Plain text representation of the concept |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.period | |
| Short | Period during which the qualification is valid |
| Definition | Period during which the qualification is valid. |
| Cardinality | 1..1 |
| Type | Period |
| Must Support | True |
| Requirements | Qualifications are often for a limited period of time, and can be revoked. |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.period.id | |
| Short | 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. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Practitioner.qualification.period.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.period.start | |
| Short | Starting time with inclusive boundary |
| Definition | The start of the period. The boundary is inclusive. |
| Cardinality | 1..1 |
| Type | dateTime |
| Must Support | True |
| Summary | True |
| Comments | If the low element is missing, the meaning is that the low boundary is not known. |
| Conditions | The cardinality or value of this element may be affected by these constraints: per-1 |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.period.end | |
| Short | End time with inclusive boundary, if not ongoing |
| Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
| Cardinality | 0..1 |
| Type | dateTime |
| Must Support | True |
| Summary | True |
| Comments | The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. |
| Meaning when missing | If the end of the period is missing, it means that the period is ongoing |
| Conditions | The cardinality or value of this element may be affected by these constraints: per-1 |
| Constraints |
|
| Mappings |
|
| Practitioner.qualification.issuer | |
| Short | Organization that regulates and issues the qualification |
| Definition | Organization that regulates and issues the qualification. |
| Cardinality | 0..1 |
| Type | Reference(Organization) |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Constraints |
|
| Mappings |
|
| Practitioner.communication | |
| Short | A language which may be used to communicate with the practitioner |
| Definition | A language which may be used to communicate with the practitioner, often for correspondence/administrative purposes. The |
| Cardinality | 0..* |
| Type | BackboneElement |
| Comments | If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Practitioner.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. |
| Constraints |
|
| Mappings |
|
| Practitioner.communication.id | |
| Short | 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. |
| Cardinality | 0..1 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Practitioner.communication.extension | |
| Short | Additional content defined by implementations |
| 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 managable, 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) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Practitioner.communication.modifierExtension | |
| Short | Extensions that cannot be ignored even if unrecognized |
| 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 managable, 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. |
| Constraints |
|
| Mappings |
|
| Practitioner.communication.language | |
| Short | The language code used to communicate with the practitioner |
| Definition | The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-AU" for Australian English. |
| Cardinality | 1..1 |
| Type | CodeableConcept |
| Binding | IETF language tag for a human language |
| Requirements | Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. |
| Comments | The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. |
| Constraints |
|
| Mappings |
|
| Practitioner.communication.preferred | |
| Short | Language preference indicator |
| Definition | Indicates whether or not the person prefers this language (over other languages he masters up a certain level). |
| Cardinality | 0..1 |
| Type | boolean |
| Requirements | People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method. |
| Comments | This language is specifically identified for communicating directly with the practitioner (typically un-related to patient communications). |
| Constraints |
|
| Mappings |
|
Constraints
| Path | Id | Grade | Details | Expression |
|---|---|---|---|---|
| Practitioner.telecom | nppr-telecom-phone-1 | warning | If telecom.system = #phone, value should follow format +46123456789 | value.matches('^\\+[1-9][0-9]+$') or system != 'phone' |
| Practitioner.telecom | nppr-telecom-url-1 | warning | If telecom.system = #url, value should follow valid format. Example: https://example.com | value.matches('(https?|ftp)://(-\\.)?([^\\s/?\\.#-]+\\.?)+(/[^\\s]*)?$') or system != 'url' |
| Practitioner.telecom | nppr-telecom-email-1 | warning | If telecom.system = #email, value should follow valid format Example: test@test.com | value.matches('^[\\w.-]{1,64}@(?!.{254})[\\w.-]+\\.[A-Za-z]{2,4}$') or system != 'email' |
Terminology Bindings
This section is not applicable to this resource and therefore contains no content.
Mapping
A mapping between this profile and the information model is shown below.
| NPPRYrkesutovareLogical | Base | ||
| id | C | 1..1 | Identifier |
| fornamn | 1..* | string | |
| efternamn | 1..1 | string | |
| harDokumenteradFormellickeFormell | C | 0..* | Reference(NPPRKompetensLogical) |
| relationKontaktuppgift | C | 0..* | Reference(NPPRKontaktuppgiftLogical) |
Examples
Practitioner that has a prescriber code
Practitioner that has a prescriber code (qualification identifier with system "urn:oid:1.2.752.116.3.1.2") and HOSP ID (qualification identifier with system "urn:oid:1.2.752.116.3.1.1"
| Practitioner |
| id : 2709bd4c-2386-4fd7-8277-9b8106087d55 |
| meta |
| profile : http://electronichealth.se/fhir/NPPR/StructureDefinition/NPPRPractitioner |
| text |
| status : additional |
| identifier |
| use : official |
| system : http://electronichealth.se/identifier/personnummer |
| value : 198001032385 |
| period |
| start : 1980-01-03 |
| assigner |
| display : Skatteverket |
| name |
| use : official |
| text : Tom Andersson |
| family : Andersson |
| given : Tom |
| telecom |
| system : phone |
| value : +46701234567 |
| period |
| start : 2025-01-01 |
| end : 2025-12-31 |
| qualification |
| identifier |
| use : official |
| system : urn:oid:1.2.752.116.3.1.2 |
| value : 456789 |
| code |
| coding |
| system : http://snomed.info/sct |
| version : http://snomed.info/sct/45991000052106 |
| code : 309453006 |
| period |
| start : 2010-05-01 |
| end : 2030-05-01 |
| qualification |
| identifier |
| use : official |
| system : urn:oid:1.2.752.116.3.1.1 |
| value : 987654 |
| code |
| coding |
| system : http://snomed.info/sct |
| version : http://snomed.info/sct/45991000052106 |
| code : 309453006 |
| period |
| start : 2005-01-01 |
| end : 2035-01-01 |
| issuer |
| display : Socialstyrelsen |