Interweave Implementation Guide
0.1.0 - ci-build

Interweave Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: CareConnect-Practitioner-1 - Detailed Descriptions

Draft as of 2018-11-05

Definitions for the CareConnect-Practitioner-1 resource profile.

Guidance on how to interpret the contents of this table can be found here.

1. Practitioner
2. Practitioner.extension
SlicingThis element introduces a set of slices on Practitioner.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3. Practitioner.extension:nhsCommunication
SliceNamenhsCommunication
Control0..?
TypeExtension(Extension-CareConnect-NHSCommunication-1) (Complex Extension)
4. Practitioner.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
SlicingThis element introduces a set of slices on Practitioner.identifier. The slices are unordered and Open at End, and can be differentiated using the following discriminators:
  • value @ system
5. Practitioner.identifier:sdsUserID
SliceNamesdsUserID
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
6. Practitioner.identifier:sdsUserID.system
Control1..?
Fixed Valuehttps://fhir.nhs.uk/Id/sds-user-id
7. Practitioner.identifier:sdsUserID.value
Control1..?
8. Practitioner.identifier:sdsUserID.assigner
Control0..?
TypeReference(CareConnect-Organization-1)
9. Practitioner.identifier:sdsRoleProfileID
SliceNamesdsRoleProfileID
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..?
10. Practitioner.identifier:sdsRoleProfileID.system
Control1..?
Fixed Valuehttps://fhir.nhs.uk/Id/sds-role-profile-id
11. Practitioner.identifier:sdsRoleProfileID.value
Control1..?
12. Practitioner.identifier:sdsRoleProfileID.assigner
Control0..?
TypeReference(CareConnect-Organization-1)
13. Practitioner.gender
BindingThe codes SHALL be taken from Administrative GenderThe codes SHALL be taken from AdministrativeGender
14. Practitioner.qualification
Control0..?
15. Practitioner.qualification.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..?
16. Practitioner.qualification.identifier.assigner
Control0..?
TypeReference(CareConnect-Organization-1)
17. Practitioner.qualification.issuer
TypeReference(CareConnect-Organization-1|Organization)
18. Practitioner.communication
Control0..0*

Guidance on how to interpret the contents of this table can be found here.

1. Practitioner
Definition

A person who is directly or indirectly involved in the provisioning of healthcare.

Control0..*
Comments

Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual?

InvariantsDefined on this element
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (: contained.where(('#'+id in %resource.descendants().reference).not()).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
2. Practitioner.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Summarytrue
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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

3. Practitioner.extension
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

SlicingThis element introduces a set of slices on Practitioner.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. Practitioner.extension:nhsCommunication
SliceNamenhsCommunication
Definition

Communication preferences including a list of Languages which may be used for communication

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-NHSCommunication-1) (Complex Extension)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
5. Practitioner.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, 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.

6. Practitioner.identifier
Definition

An identifier that applies to this person in this role.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
Requirements

Often, specific identities are assigned for the agent.

SlicingThis element introduces a set of slices on Practitioner.identifier. The slices are unordered and Open at End, and can be differentiated using the following discriminators:
  • value @ system
7. Practitioner.identifier:sdsUserID
SliceNamesdsUserID
Definition

An identifier that applies to this person in this role.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1*
TypeIdentifier
Summarytrue
Requirements

Often, specific identities are assigned for the agent.

8. Practitioner.identifier:sdsUserID.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

9. Practitioner.identifier:sdsUserID.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control10..1
Typeuri
Summarytrue
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.

Fixed Valuehttps://fhir.nhs.uk/Id/sds-user-id
Example
General:http://www.acme.com/identifiers/patient
10. Practitioner.identifier:sdsUserID.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control10..1
Typestring
Summarytrue
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 Rendered Value extension.

Example
General:123456
11. Practitioner.identifier:sdsUserID.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(CareConnect-Organization-1|Organization)
Summarytrue
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.

12. Practitioner.identifier:sdsRoleProfileID
SliceNamesdsRoleProfileID
Definition

An identifier that applies to this person in this role.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
Requirements

Often, specific identities are assigned for the agent.

13. Practitioner.identifier:sdsRoleProfileID.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

14. Practitioner.identifier:sdsRoleProfileID.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control10..1
Typeuri
Summarytrue
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.

Fixed Valuehttps://fhir.nhs.uk/Id/sds-role-profile-id
Example
General:http://www.acme.com/identifiers/patient
15. Practitioner.identifier:sdsRoleProfileID.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control10..1
Typestring
Summarytrue
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 Rendered Value extension.

Example
General:123456
16. Practitioner.identifier:sdsRoleProfileID.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(CareConnect-Organization-1|Organization)
Summarytrue
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.

17. Practitioner.gender
Definition

Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

Control0..1
BindingThe codes SHALL be taken from Administrative GenderThe codes SHALL be taken from AdministrativeGender
Typecode
Summarytrue
Requirements

Needed to address the person correctly.

18. Practitioner.communication
Definition

A language the practitioner is able to use in patient communication.

Control0..0*
BindingThe codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
TypeCodeableConcept
Requirements

Knowing which language a practitioner speaks can help in facilitating communication with patients.

Comments

The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

Guidance on how to interpret the contents of this table can be found here.

1. Practitioner
Definition

A person who is directly or indirectly involved in the provisioning of healthcare.

Control0..*
Comments

Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual?

2. Practitioner.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Summarytrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

3. Practitioner.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
Summarytrue
4. Practitioner.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Summarytrue
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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

5. Practitioner.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable A human language
Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
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).

6. Practitioner.text
Definition

A human-readable narrative that contains a summary of the resource, and may 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.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

7. Practitioner.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline 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.

8. Practitioner.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on Practitioner.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. Practitioner.extension:nhsCommunication
SliceNamenhsCommunication
Definition

Communication preferences including a list of Languages which may be used for communication

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-NHSCommunication-1) (Complex Extension)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. Practitioner.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, 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.

11. Practitioner.identifier
Definition

An identifier that applies to this person in this role.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
Requirements

Often, specific identities are assigned for the agent.

SlicingThis element introduces a set of slices on Practitioner.identifier. The slices are unordered and Open at End, and can be differentiated using the following discriminators:
  • value @ system
12. Practitioner.identifier:sdsUserID
SliceNamesdsUserID
Definition

An identifier that applies to this person in this role.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Summarytrue
Requirements

Often, specific identities are assigned for the agent.

13. Practitioner.identifier:sdsUserID.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
14. Practitioner.identifier:sdsUserID.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

SlicingThis element introduces a set of slices on Practitioner.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
15. Practitioner.identifier:sdsUserID.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Typecode
Is Modifiertrue
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

16. Practitioner.identifier:sdsUserID.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control0..1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
TypeCodeableConcept
Summarytrue
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.

17. Practitioner.identifier:sdsUserID.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control1..1
Typeuri
Summarytrue
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.

Fixed Valuehttps://fhir.nhs.uk/Id/sds-user-id
Example
General:http://www.acme.com/identifiers/patient
18. Practitioner.identifier:sdsUserID.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control1..1
Typestring
Summarytrue
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 Rendered Value extension.

Example
General:123456
19. Practitioner.identifier:sdsUserID.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
Summarytrue
20. Practitioner.identifier:sdsUserID.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(CareConnect-Organization-1)
Summarytrue
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.

21. Practitioner.identifier:sdsRoleProfileID
SliceNamesdsRoleProfileID
Definition

An identifier that applies to this person in this role.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
Requirements

Often, specific identities are assigned for the agent.

22. Practitioner.identifier:sdsRoleProfileID.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
23. Practitioner.identifier:sdsRoleProfileID.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

SlicingThis element introduces a set of slices on Practitioner.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
24. Practitioner.identifier:sdsRoleProfileID.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Typecode
Is Modifiertrue
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

25. Practitioner.identifier:sdsRoleProfileID.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control0..1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
TypeCodeableConcept
Summarytrue
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.

26. Practitioner.identifier:sdsRoleProfileID.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control1..1
Typeuri
Summarytrue
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.

Fixed Valuehttps://fhir.nhs.uk/Id/sds-role-profile-id
Example
General:http://www.acme.com/identifiers/patient
27. Practitioner.identifier:sdsRoleProfileID.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control1..1
Typestring
Summarytrue
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 Rendered Value extension.

Example
General:123456
28. Practitioner.identifier:sdsRoleProfileID.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
Summarytrue
29. Practitioner.identifier:sdsRoleProfileID.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(CareConnect-Organization-1)
Summarytrue
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.

30. Practitioner.active
Definition

Whether this practitioner's record is in active use.

Control0..1
Typeboolean
Summarytrue
Requirements

Need to be able to mark a practitioner record as not to be used because it was created in error.

Comments

Default is true.

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.

Default Valuetrue
31. Practitioner.name
Definition

The name(s) associated with the practitioner.

Control0..*
TypeHumanName
Summarytrue
Requirements

The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.

Comments

The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate.

In general select the value to be used in the ResourceReference.display based on this:

  1. There is more than 1 name
  2. Use = usual
  3. Period is current to the date of the usage
  4. Use = official
  5. Other order as decided by internal business rules.
32. Practitioner.telecom
Definition

A contact detail for the practitioner, e.g. a telephone number or an email address.

Control0..*
TypeContactPoint
Summarytrue
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 also to help with identification

These typically will have home numbers, or mobile numbers that are not role specific.

33. Practitioner.address
Definition

Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.

Control0..*
TypeAddress
Summarytrue
Requirements

The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations.

Comments

The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).

34. Practitioner.gender
Definition

Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

Control0..1
BindingThe codes SHALL be taken from Administrative Gender
Typecode
Summarytrue
Requirements

Needed to address the person correctly.

35. Practitioner.birthDate
Definition

The date of birth for the practitioner.

Control0..1
Typedate
Summarytrue
Requirements

Needed for identification.

36. Practitioner.photo
Definition

Image of the person.

Control0..*
TypeAttachment
Requirements

Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.

37. Practitioner.qualification
Definition

Qualifications obtained by training and certification.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
38. Practitioner.qualification.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
39. Practitioner.qualification.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

40. Practitioner.qualification.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Alternate Namesextensions, user content, modifiers
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.

41. Practitioner.qualification.identifier
Definition

An identifier that applies to this person's qualification in this role.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Often, specific identities are assigned for the qualification.

42. Practitioner.qualification.identifier.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
43. Practitioner.qualification.identifier.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

SlicingThis element introduces a set of slices on Practitioner.qualification.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
44. Practitioner.qualification.identifier.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Typecode
Is Modifiertrue
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

45. Practitioner.qualification.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control0..1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
TypeCodeableConcept
Summarytrue
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.

46. Practitioner.qualification.identifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control0..1
Typeuri
Summarytrue
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.

Example
General:http://www.acme.com/identifiers/patient
47. Practitioner.qualification.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control0..1
Typestring
Summarytrue
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 Rendered Value extension.

Example
General:123456
48. Practitioner.qualification.identifier.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
Summarytrue
49. Practitioner.qualification.identifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(CareConnect-Organization-1)
Summarytrue
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.

50. Practitioner.qualification.code
Definition

Coded representation of the qualification.

Control1..1
BindingFor example codes, see v2 table 0360, Version 2.7 Specific qualification the practitioner has to provide a servic
TypeCodeableConcept
51. Practitioner.qualification.period
Definition

Period during which the qualification is valid.

Control0..1
TypePeriod
Requirements

Qualifications are often for a limited period of time, and can be revoked.

52. Practitioner.qualification.issuer
Definition

Organization that regulates and issues the qualification.

Control0..1
TypeReference(CareConnect-Organization-1)
53. Practitioner.communication
Definition

A language the practitioner is able to use in patient communication.

Control0..0
BindingThe codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable A human language
Additional BindingsPurpose
AllLanguagesMax Binding
TypeCodeableConcept
Requirements

Knowing which language a practitioner speaks can help in facilitating communication with patients.

Comments

The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.