PractitionerRole R5 (FHIR) at fhirtruck

Path

PractitionerRole

Id

PractitionerRole

Cardinality

0 - *

Definition

A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

Comment

Constraint

dom-2 [error]

If the resource is contained in another resource, it SHALL NOT contain nested Resources

dom-3 [error]

If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource

dom-4 [error]

If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated

dom-5 [error]

If a resource is contained in another resource, it SHALL NOT have a security label

dom-6 [warning]

A resource should have narrative for robust management

Path

PractitionerRole.identifier

Id

PractitionerRole.identifier

Type

Identifier

Cardinality

0 - *

Definition

Business Identifiers that are specific to a role/location.

Comment

A specific identifier value (e.g. Minnesota Registration ID) may appear on multiple PractitionerRole instances which could be for different periods, or different Roles (or other reasons). A specific identifier may be included multiple times in the same PractitionerRole instance with different identifier validity periods.

Requirements

Often, specific identities are assigned for the agent.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

use

Summary: The element appears in the summary view

code

usual | official | temp | secondary | old (If known)

type

CodeableConcept

Description of identifier

coding

List: This element is a list and more than one value can be provided

Coding

Code defined by a terminology system

system

uri

Identity of the terminology system

version

string

Version of the system - if relevant

code

Symbol in syntax defined by the system

display

string

Representation defined by the system

userSelected

boolean

If this coding was chosen directly by the user

system

uri

The namespace for the identifier value

value

string

The value that is unique

period

Period

Time period when id is/was valid for use

start

dateTime

Starting time with inclusive boundary

end

dateTime

End time with inclusive boundary, if not ongoing

assigner

Reference

Organization that issued id (may be just text)

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

PractitionerRole.identifier.Identifier.assigner.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

use

code

usual | official | temp | secondary | old (If known)

type

CodeableConcept

Description of identifier

system

uri

The namespace for the identifier value

value

string

The value that is unique

period

Period

Time period when id is/was valid for use

assigner

Reference

Organization that issued id (may be just text)

display

string

Text alternative for the resource

Path

PractitionerRole.active

Id

PractitionerRole.active

Type

boolean

Cardinality

0 - 1

Definition

Whether this practitioner role record is in active use. Some systems may use this property to mark non-active practitioners, such as those that are not currently employed.

Comment

If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.

Requirements

Need to be able to mark a practitioner role record as not to be used because it was created in error, or otherwise no longer in active use.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

PractitionerRole.period

Id

PractitionerRole.period

Type

Period

Cardinality

0 - 1

Definition

The period during which the person is authorized to act as a practitioner in these role(s) for the organization.

Comment

If a practitioner is performing a role within an organization over multiple, non-adjacent periods, there should be a distinct PractitionerRole instance for each period. For example, if a nurse is employed at a hospital, leaves the organization for a period of time due to pandemic related stress, but returns post-pandemic to the same job role, there would be two PractitionerRole instances for the different periods of employment.

Requirements

Even after the agencies is revoked, the fact that it existed must still be recorded.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

start

dateTime

Starting time with inclusive boundary

end

dateTime

End time with inclusive boundary, if not ongoing

Path

PractitionerRole.practitioner

Id

PractitionerRole.practitioner

Type

Reference

Cardinality

0 - 1

Definition

Practitioner that is able to provide the defined services for the organization.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

PractitionerRole.practitioner.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

use

code

usual | official | temp | secondary | old (If known)

type

CodeableConcept

Description of identifier

system

uri

The namespace for the identifier value

value

string

The value that is unique

period

Period

Time period when id is/was valid for use

start

dateTime

Starting time with inclusive boundary

end

dateTime

End time with inclusive boundary, if not ongoing

assigner

Reference

Organization that issued id (may be just text)

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

PractitionerRole.practitioner.Reference.identifier.Identifier.assigner.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

display

string

Text alternative for the resource

display

string

Text alternative for the resource

Path

PractitionerRole.organization

Id

PractitionerRole.organization

Type

Reference

Cardinality

0 - 1

Definition

The organization where the Practitioner performs the roles associated.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

PractitionerRole.organization.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

use

code

usual | official | temp | secondary | old (If known)

type

CodeableConcept

Description of identifier

system

uri

The namespace for the identifier value

value

string

The value that is unique

period

Period

Time period when id is/was valid for use

start

dateTime

Starting time with inclusive boundary

end

dateTime

End time with inclusive boundary, if not ongoing

assigner

Reference

Organization that issued id (may be just text)

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

PractitionerRole.organization.Reference.identifier.Identifier.assigner.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

display

string

Text alternative for the resource

display

string

Text alternative for the resource

Path

PractitionerRole.code

Id

PractitionerRole.code

Type

CodeableConcept

Cardinality

0 - *

Definition

Roles which this practitioner is authorized to perform for the organization.

Comment

A person may have more than one role.

Requirements

Need to know what authority the practitioner has - what can they do?

Binding

Strength

example

Description

The role a person plays representing an organization.

ValueSet

http://hl7.org/fhir/ValueSet/practitioner-role

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

coding

Coding

Code defined by a terminology system

system

uri

Identity of the terminology system

version

string

Version of the system - if relevant

code

Symbol in syntax defined by the system

display

string

Representation defined by the system

userSelected

boolean

If this coding was chosen directly by the user

Path

PractitionerRole.specialty

Id

PractitionerRole.specialty

Type

CodeableConcept

Cardinality

0 - *

Definition

The specialty of a practitioner that describes the functional role they are practicing at a given organization or location.

Comment

The specialty represents the functional role a practitioner is playing within an organization/location. This role may require the individual have certain qualifications, which would be represented in the Practitioner.qualifications property. Note that qualifications may or might not relate to or be required by the practicing specialty.

Binding

Strength

preferred

Description

Specific specialty associated with the agency.

ValueSet

http://hl7.org/fhir/ValueSet/c80-practice-codes

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

coding

Coding

Code defined by a terminology system

system

uri

Identity of the terminology system

version

string

Version of the system - if relevant

code

Symbol in syntax defined by the system

display

string

Representation defined by the system

userSelected

boolean

If this coding was chosen directly by the user

Path

PractitionerRole.location

Id

PractitionerRole.location

Type

Reference

Cardinality

0 - *

Definition

The location(s) at which this practitioner provides care.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

PractitionerRole.location.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

use

code

usual | official | temp | secondary | old (If known)

type

CodeableConcept

Description of identifier

system

uri

The namespace for the identifier value

value

string

The value that is unique

period

Period

Time period when id is/was valid for use

start

dateTime

Starting time with inclusive boundary

end

dateTime

End time with inclusive boundary, if not ongoing

assigner

Reference

Organization that issued id (may be just text)

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

PractitionerRole.location.Reference.identifier.Identifier.assigner.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

display

string

Text alternative for the resource

display

string

Text alternative for the resource

Path

PractitionerRole.healthcareService

Id

PractitionerRole.healthcareService

Type

Reference

Cardinality

0 - *

Definition

The list of healthcare services that this worker provides for this role's Organization/Location(s).

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

PractitionerRole.healthcareService.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

use

code

usual | official | temp | secondary | old (If known)

type

CodeableConcept

Description of identifier

system

uri

The namespace for the identifier value

value

string

The value that is unique

period

Period

Time period when id is/was valid for use

start

dateTime

Starting time with inclusive boundary

end

dateTime

End time with inclusive boundary, if not ongoing

assigner

Reference

Organization that issued id (may be just text)

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

PractitionerRole.healthcareService.Reference.identifier.Identifier.assigner.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

display

string

Text alternative for the resource

display

string

Text alternative for the resource

Path

PractitionerRole.contact

Id

PractitionerRole.contact

Type

ExtendedContactDetail

Cardinality

0 - *

Definition

The contact details of communication devices available relevant to the specific PractitionerRole. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.

Comment

Requirements

Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these. Sometimes these also include a named person/organization that handles contact for specific purposes, such as a receptionist, or accounts clerk etc.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

purpose

CodeableConcept

The type of contact

coding

Coding

Code defined by a terminology system

system

uri

Identity of the terminology system

version

string

Version of the system - if relevant

code

Symbol in syntax defined by the system

display

string

Representation defined by the system

userSelected

boolean

If this coding was chosen directly by the user

name

HumanName

Name of an individual to contact

use

code

family

string

Family name (often called 'Surname')

given

string

Given names (not always 'first'). Includes middle names

prefix

string

Parts that come before the name

suffix

string

Parts that come after the name

period

Period

Time period when name was/is in use

start

dateTime

Starting time with inclusive boundary

end

dateTime

End time with inclusive boundary, if not ongoing

telecom

ContactPoint

Contact details (e.g.phone/fax/url)

system

code

phone | fax | email | pager | url | sms | other

value

string

The actual contact point details

use

code

home | work | temp | old | mobile - purpose of this contact point

rank

positiveInt

Specify preferred order of use (1 = highest)

period

Period

Time period when the contact point was/is in use

start

dateTime

Starting time with inclusive boundary

end

dateTime

End time with inclusive boundary, if not ongoing

address

Address

Address for the contact

use

code

home | work | temp | old | billing - purpose of this address

type

code

postal | physical | both

line

string

Street name, number, direction & P.O. Box etc.

city

string

Name of city, town etc.

district

string

District name (aka county)

state

string

Sub-unit of country (abbreviations ok)

postalCode

string

Postal code for area

country

string

Country (e.g. may be ISO 3166 2 or 3 letter code)

period

Period

Time period when address was/is in use

start

dateTime

Starting time with inclusive boundary

end

dateTime

End time with inclusive boundary, if not ongoing

organization

Reference

This contact detail is handled/monitored by a specific organization

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

PractitionerRole.contact.ExtendedContactDetail.organization.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

use

code

usual | official | temp | secondary | old (If known)

type

CodeableConcept

Description of identifier

system

uri

The namespace for the identifier value

value

string

The value that is unique

period

Period

Time period when id is/was valid for use

assigner

Reference

Organization that issued id (may be just text)

display

string

Text alternative for the resource

period

Period

Period that this contact was valid for usage

start

dateTime

Starting time with inclusive boundary

end

dateTime

End time with inclusive boundary, if not ongoing

Path

PractitionerRole.characteristic

Id

PractitionerRole.characteristic

Type

CodeableConcept

Cardinality

0 - *

Definition

Collection of characteristics (attributes).

Comment

These could be such things as is the service mode used by this role.

Binding

Strength

example

Description

A custom attribute that could be provided at a service (e.g. Wheelchair accessibility).

ValueSet

http://hl7.org/fhir/ValueSet/service-mode

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

coding

Coding

Code defined by a terminology system

system

uri

Identity of the terminology system

version

string

Version of the system - if relevant

code

Symbol in syntax defined by the system

display

string

Representation defined by the system

userSelected

boolean

If this coding was chosen directly by the user

Path

PractitionerRole.communication

Id

PractitionerRole.communication

Type

CodeableConcept

Cardinality

0 - *

Definition

A language the practitioner can use in patient communication. The practitioner may know several languages (listed in practitioner.communication), however these are the languages that could be advertised in a directory for a patient to search.

Comment

The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. Note that for non-patient oriented communication, see Practitioner.communication. Note that all 'person' type resources (Person, RelatedPerson, Patient, Practitioner) have a communication structure that includes preferences. Role or service oriented resources such as HealthcareService and PractitionerRole only include languages that are available for interacting with patients.

Requirements

Knowing which language a practitioner speaks can help in facilitating patients to locate practitioners that speak their language.

Binding

Strength

required

Description

IETF language tag for a human language

ValueSet

http://hl7.org/fhir/ValueSet/all-languages|5.0.0

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

coding

Coding

Code defined by a terminology system

system

uri

Identity of the terminology system

version

string

Version of the system - if relevant

code

Symbol in syntax defined by the system

display

string

Representation defined by the system

userSelected

boolean

If this coding was chosen directly by the user

Path

PractitionerRole.availability

Id

PractitionerRole.availability

Type

Availability

Cardinality

0 - *

Definition

A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.

Comment

More detailed availability information may be provided in associated Schedule/Slot resources. Systems may choose to render availability differently than it is exchanged on the interface. For example, rather than "Mon, Tue, Wed, Thur, Fri from 9am-12am; Mon, Tue, Wed, Thur, Fri from 1pm-5pm" as would be implied by two availableTime repetitions, an application could render this information as "Mon-Fri 9-12am and 1-5pm". The NotAvailableTime(s) included indicate the general days/periods where the practitioner is not available (for things such as vacation time, or public holidays).

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

availableTime

Element

Times the {item} is available

daysOfWeek

code

mon | tue | wed | thu | fri | sat | sun

allDay

boolean

Always available? i.e. 24 hour service

availableStartTime

time

Opening time of day (ignored if allDay = true)

availableEndTime

time

Closing time of day (ignored if allDay = true)

notAvailableTime

Element

Not available during this time due to provided reason

description

string

Reason presented to the user explaining why time not available

Path

PractitionerRole.availability.Availability.notAvailableTime.description

Id

Availability.notAvailableTime.description

Type

string

Cardinality

0 - 1

Definition

Reason presented to the user explaining why time not available.

Comment

The reason will generally be provided to give the textual reason for displaying when the {item} is not available, e.g. 'Closed public holidays' or 'Independence Day'. In cases such as this, the `during` might not be included and local knowledge would be required in such cases (as don't desire to keep updating when the holiday occurs each year). e.g.2: 'Closed for maintenance over the summer' for this example you would want to include the `during` period, unless this was a university hospital and the "summer" period was well known, but would recommend its inclusion anyway.

Requirements

The reason that can be presented to the user as to why this time is not available.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

during

Period

Service not available during this period

start

dateTime

Starting time with inclusive boundary

end

dateTime

End time with inclusive boundary, if not ongoing

Path

PractitionerRole.endpoint

Id

PractitionerRole.endpoint

Type

Reference

Cardinality

0 - *

Definition

Technical endpoints providing access to services operated for the practitioner with this role. Commonly used for locating scheduling services, or identifying where to send referrals electronically.

Comment

Requirements

Organizations have multiple systems that provide various services and may also be different for practitioners too. So the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

PractitionerRole.endpoint.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

use

code

usual | official | temp | secondary | old (If known)

type

CodeableConcept

Description of identifier

system

uri

The namespace for the identifier value

value

string

The value that is unique

period

Period

Time period when id is/was valid for use

start

dateTime

Starting time with inclusive boundary

end

dateTime

End time with inclusive boundary, if not ongoing

assigner

Reference

Organization that issued id (may be just text)

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

PractitionerRole.endpoint.Reference.identifier.Identifier.assigner.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

display

string

Text alternative for the resource

display

string

Text alternative for the resource