NHSDigital-PractitionerRole
Conformance url | FHIR Module | Maturity Level |
---|---|---|
https://fhir.nhs.uk/StructureDefinition/NHSDigital-PractitionerRole | Administration | normative |
UK Core PractitionerRole
PractitionerRole | I | PractitionerRole | Element IdPractitionerRole Roles/organizations the practitioner is associated with DefinitionA specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
| ||||||||||||||||||||||
extension | I | 0..* | Extension | Element IdPractitionerRole.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Constraints
| |||||||||||||||||||||
costCentre | S I | 0..1 | Extension(Complex) | Element IdPractitionerRole.extension:costCentre Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. Extension(Complex) Extension URLhttps://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-Account-code Constraints
| |||||||||||||||||||||
identifier | S Σ | 0..* | Identifier | Element IdPractitionerRole.identifier An identifier that applies to this person in this role. Definition
The SDS Role Profile Code should be sourced from NHS Identity (SmartCard), this is also held within the Spine Directory Service LDAP database. Holds NHS BSA spurious codes which are role specific Doctor Index Number (DIN)) codes. NHS BSA spurious codes are issued when a doctor issues medication outside of their normal role, normally at another organisation. In the example below, the doctor is working in a secondary role (with SDS Role Id of 100102238986), as this a has a spurious code of 2345213. If the doctor was prescribing in their primary role this spurious code would be absent.
Often, specific identities are assigned for the agent. Unordered, Open, by system(Value) Constraints
| |||||||||||||||||||||
(All Slices) | There are no (further) constraints on this element | ||||||||||||||||||||||||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
| |||||||||||||||||||||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPractitionerRole.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
| |||||||||||||||||||||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element IdPractitionerRole.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
| |||||||||||||||||||||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
| |||||||||||||||||||||
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
| |||||||||||||||||||||
assigner | Σ I | 0..1 | Reference(UK Core Organization) | There are no (further) constraints on this element Element IdPractitionerRole.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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. Reference(UK Core Organization) Constraints
| |||||||||||||||||||||
sdsRoleProfileID | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdPractitionerRole.identifier:sdsRoleProfileID An identifier that applies to this person in this role. DefinitionAn identifier that applies to this person in this role. Often, specific identities are assigned for the agent.
| |||||||||||||||||||||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.identifier:sdsRoleProfileID.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
| |||||||||||||||||||||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPractitionerRole.identifier:sdsRoleProfileID.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
| |||||||||||||||||||||
system | Σ | 1..1 | uriFixed Value | Element IdPractitionerRole.identifier:sdsRoleProfileID.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
https://fhir.nhs.uk/Id/sds-role-profile-id
| |||||||||||||||||||||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.identifier:sdsRoleProfileID.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
| |||||||||||||||||||||
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.identifier:sdsRoleProfileID.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
| |||||||||||||||||||||
assigner | Σ I | 0..1 | Reference(UK Core Organization) | There are no (further) constraints on this element Element IdPractitionerRole.identifier:sdsRoleProfileID.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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. Reference(UK Core Organization) Constraints
| |||||||||||||||||||||
nhsbsaSpuriousCode | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdPractitionerRole.identifier:nhsbsaSpuriousCode An identifier that applies to this person in this role. DefinitionAn identifier that applies to this person in this role. Often, specific identities are assigned for the agent.
| |||||||||||||||||||||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.identifier:nhsbsaSpuriousCode.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
| |||||||||||||||||||||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPractitionerRole.identifier:nhsbsaSpuriousCode.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
| |||||||||||||||||||||
system | Σ | 1..1 | uriFixed Value | Element IdPractitionerRole.identifier:nhsbsaSpuriousCode.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
https://fhir.hl7.org.uk/Id/nhsbsa-spurious-code
| |||||||||||||||||||||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.identifier:nhsbsaSpuriousCode.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
| |||||||||||||||||||||
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.identifier:nhsbsaSpuriousCode.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
| |||||||||||||||||||||
assigner | Σ I | 0..1 | Reference(UK Core Organization) | There are no (further) constraints on this element Element IdPractitionerRole.identifier:nhsbsaSpuriousCode.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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. Reference(UK Core Organization) Constraints
| |||||||||||||||||||||
active | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitionerRole.active Whether this practitioner role record is in active use DefinitionWhether this practitioner role record is in active use. 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. 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. This resource is generally assumed to be active if no value is provided for the active element
| |||||||||||||||||||||
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.period The period during which the practitioner is authorized to perform in these role(s) DefinitionThe period during which the person is authorized to act as a practitioner in these role(s) for the organization. Even after the agencies is revoked, the fact that it existed must still be recorded. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
| |||||||||||||||||||||
practitioner | S Σ I | 0..1 | Reference(NHSDigitalPractitioner) | Element IdPractitionerRole.practitioner Practitioner that is able to provide the defined services for the organization DefinitionThis MUST either be a reference to a Practitioner resource or an identifier reference plus a display. In both cases the referenced resource or identfier reference should contain a professional code. It is recommended an identifier reference and display (practioner full name) is included. This identifier should be the Practitioner's primary professional code (see
For EPS, currently a Resource reference is required.
References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(NHSDigitalPractitioner) Constraints
| |||||||||||||||||||||
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.practitioner.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
| |||||||||||||||||||||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdPractitionerRole.practitioner.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
| |||||||||||||||||||||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdPractitionerRole.practitioner.identifier Logical reference, when literal reference is not known DefinitionAn 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. 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).
| |||||||||||||||||||||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.practitioner.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
| |||||||||||||||||||||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPractitionerRole.practitioner.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
| |||||||||||||||||||||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdPractitionerRole.practitioner.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
| |||||||||||||||||||||
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.practitioner.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
| |||||||||||||||||||||
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.practitioner.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
| |||||||||||||||||||||
assigner | Σ I | 0..1 | Reference(UK Core Organization) | There are no (further) constraints on this element Element IdPractitionerRole.practitioner.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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. Reference(UK Core Organization) Constraints
| |||||||||||||||||||||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.practitioner.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| |||||||||||||||||||||
organization | S Σ I | 0..1 | Reference(NHSDigitalOrganization) | Element IdPractitionerRole.organization Organization where the roles are available DefinitionThis MUST either be a reference to a Organization resource or an identifier reference. In both cases the reference must contain an ANANA/ODS organisation code. organisation resource referencesIt is recommended an identifier reference is included.
Optionally Resource reference can be provided. This is required in the current version of EPS but this will be changed to supporting the identifier reference only.
References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(NHSDigitalOrganization) Constraints
| |||||||||||||||||||||
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.organization.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
| |||||||||||||||||||||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdPractitionerRole.organization.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
| |||||||||||||||||||||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdPractitionerRole.organization.identifier Logical reference, when literal reference is not known DefinitionAn 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. 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).
| |||||||||||||||||||||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.organization.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
| |||||||||||||||||||||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPractitionerRole.organization.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
| |||||||||||||||||||||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element IdPractitionerRole.organization.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
| |||||||||||||||||||||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.organization.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
| |||||||||||||||||||||
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.organization.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
| |||||||||||||||||||||
assigner | Σ I | 0..1 | Reference(UK Core Organization) | There are no (further) constraints on this element Element IdPractitionerRole.organization.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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. Reference(UK Core Organization) Constraints
| |||||||||||||||||||||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.organization.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| |||||||||||||||||||||
code | S Σ | 0..* | CodeableConcept | Element IdPractitionerRole.code Roles which this practitioner may perform DefinitionOnly supply if this is known from SmartCard/CIS2 data.
The previous system for this entry was Need to know what authority the practitioner has - what can they do? A person may have more than one role. The role a person plays representing an organization. PractitionerRole (example)Constraints
| |||||||||||||||||||||
coding | Σ | 1..* | Coding | Element IdPractitionerRole.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by system(Value) Constraints
| |||||||||||||||||||||
(All Slices) | There are no (further) constraints on this element | ||||||||||||||||||||||||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element IdPractitionerRole.code.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
| |||||||||||||||||||||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.code.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
| |||||||||||||||||||||
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdPractitionerRole.code.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||||||||||||||||||||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.code.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||||||||||||||||||||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitionerRole.code.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
| |||||||||||||||||||||
sdsJobRoleCode | S Σ | 0..1 | Coding | Element IdPractitionerRole.code.coding:sdsJobRoleCode SDS Job Role Code DefinitionThis value should be sourced from either APIM OAuth2 userinfo endpoint, SDS LDAP or CIS2/SmartCard details. The CodeSystem is variable and is not present in this Implementation Guide. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
| |||||||||||||||||||||
system | Σ | 0..1 | uriFixed Value | Element IdPractitionerRole.code.coding:sdsJobRoleCode.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
https://fhir.nhs.uk/CodeSystem/NHSDigital-SDS-JobRoleCode
| |||||||||||||||||||||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:sdsJobRoleCode.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
| |||||||||||||||||||||
code | Σ | 0..1 | code | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:sdsJobRoleCode.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||||||||||||||||||||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:sdsJobRoleCode.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||||||||||||||||||||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:sdsJobRoleCode.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
| |||||||||||||||||||||
SDSJobRoleName | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:SDSJobRoleName Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
| |||||||||||||||||||||
system | Σ | 0..1 | uriFixed Value | Element IdPractitionerRole.code.coding:SDSJobRoleName.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
https://fhir.hl7.org.uk/CodeSystem/UKCore-SDSJobRoleName
| |||||||||||||||||||||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:SDSJobRoleName.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
| |||||||||||||||||||||
code | Σ | 0..1 | code | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:SDSJobRoleName.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||||||||||||||||||||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:SDSJobRoleName.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||||||||||||||||||||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:SDSJobRoleName.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
| |||||||||||||||||||||
ukCoreSNOMEDCT | Σ | 0..* | CodingBinding | Element IdPractitionerRole.code.coding:ukCoreSNOMEDCT Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. UKCorePractitionerRoleCode (preferred) Constraints
| |||||||||||||||||||||
system | Σ | 0..1 | uriFixed Value | Element IdPractitionerRole.code.coding:ukCoreSNOMEDCT.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
http://snomed.info/sct
| |||||||||||||||||||||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:ukCoreSNOMEDCT.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
| |||||||||||||||||||||
code | Σ | 0..1 | code | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:ukCoreSNOMEDCT.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||||||||||||||||||||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:ukCoreSNOMEDCT.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||||||||||||||||||||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:ukCoreSNOMEDCT.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
| |||||||||||||||||||||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.code.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
| |||||||||||||||||||||
specialty | S Σ | 0..* | CodeableConceptBinding | Element IdPractitionerRole.specialty Specific specialty of the practitioner DefinitionThis is should be the specialty linked to the role and is not necessarily the practitioners main specialty.
Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Specific specialty associated with the agency. UKCorePracticeSettingCode (extensible)Constraints
| |||||||||||||||||||||
coding | Σ | 1..* | Coding | Element IdPractitionerRole.specialty.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by system(Value) Constraints
| |||||||||||||||||||||
(All Slices) | There are no (further) constraints on this element | ||||||||||||||||||||||||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element IdPractitionerRole.specialty.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
| |||||||||||||||||||||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.specialty.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
| |||||||||||||||||||||
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdPractitionerRole.specialty.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||||||||||||||||||||
display | Σ | 1..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.specialty.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||||||||||||||||||||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitionerRole.specialty.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
| |||||||||||||||||||||
SNOMEDSpecialty | S Σ | 0..* | CodingBinding | Element IdPractitionerRole.specialty.coding:SNOMEDSpecialty Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Specific specialty associated with the agency. PracticeSettingCodeValueSet (preferred)Constraints
| |||||||||||||||||||||
system | Σ | 0..1 | uriFixed Value | Element IdPractitionerRole.specialty.coding:SNOMEDSpecialty.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
http://snomed.info/sct
| |||||||||||||||||||||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.specialty.coding:SNOMEDSpecialty.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
| |||||||||||||||||||||
code | Σ | 0..1 | code | There are no (further) constraints on this element Element IdPractitionerRole.specialty.coding:SNOMEDSpecialty.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||||||||||||||||||||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.specialty.coding:SNOMEDSpecialty.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||||||||||||||||||||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitionerRole.specialty.coding:SNOMEDSpecialty.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
| |||||||||||||||||||||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.specialty.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
| |||||||||||||||||||||
location | Σ I | 0..* | Reference(NHSDigitalLocation) | Element IdPractitionerRole.location The location(s) at which this practitioner provides care DefinitionThe contact address for the practitioner for the service they are providing in this role. This will often be the surgery address, clinic or service address. If using ODS Codes, the address on ODS must be checked to ensure it is correct. If the address is not correct, then Resource reference MUST be supplied.
For EPS, currently a Resource reference is required.
References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
| |||||||||||||||||||||
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.location.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
| |||||||||||||||||||||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdPractitionerRole.location.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
| |||||||||||||||||||||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdPractitionerRole.location.identifier Logical reference, when literal reference is not known DefinitionAn 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. 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).
| |||||||||||||||||||||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.location.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
| |||||||||||||||||||||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPractitionerRole.location.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
| |||||||||||||||||||||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element IdPractitionerRole.location.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
| |||||||||||||||||||||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.location.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
| |||||||||||||||||||||
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.location.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
| |||||||||||||||||||||
assigner | Σ I | 0..1 | Reference(UK Core Organization) | There are no (further) constraints on this element Element IdPractitionerRole.location.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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. Reference(UK Core Organization) Constraints
| |||||||||||||||||||||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.location.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| |||||||||||||||||||||
healthcareService | S I | 0..1 | Reference(NHSDigitalHealthcareService) | Element IdPractitionerRole.healthcareService The list of healthcare services that this worker provides for this role's Organization/Location(s) DefinitionSHOULD be provided for a practitioner in secondary care and will be a reference to clinic or service. This referenced resource or the identifier reference SHOULD contain a ODS/ANANA identifier. In secondary care Electronic Prescription Service (EPS) this will also be called prescribing cost centre. This is used for reimbursements from NHS BSA. In secondary care the healthchare/service cost centre may also be the ODS code for the clinic. healthcareService Resource referenceAn identifier reference MUST be included. For secondary care organisations this will be the ODS/ANANA Cost Centre code given to a clinic.
Optionally Resource reference can be provided. This is required in the current version of EPS but this will be changed to supporting the identifier reference only.
References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(NHSDigitalHealthcareService) Constraints
| |||||||||||||||||||||
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.healthcareService.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
| |||||||||||||||||||||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdPractitionerRole.healthcareService.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
| |||||||||||||||||||||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdPractitionerRole.healthcareService.identifier Logical reference, when literal reference is not known DefinitionAn 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. 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).
| |||||||||||||||||||||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.healthcareService.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
| |||||||||||||||||||||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPractitionerRole.healthcareService.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
| |||||||||||||||||||||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element IdPractitionerRole.healthcareService.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
| |||||||||||||||||||||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.healthcareService.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
| |||||||||||||||||||||
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.healthcareService.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
| |||||||||||||||||||||
assigner | Σ I | 0..1 | Reference(UK Core Organization) | There are no (further) constraints on this element Element IdPractitionerRole.healthcareService.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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. Reference(UK Core Organization) Constraints
| |||||||||||||||||||||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.healthcareService.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| |||||||||||||||||||||
telecom | S Σ I | 0..* | ContactPoint | Element IdPractitionerRole.telecom Contact details that are specific to the role/location/service DefinitionAt least one telecom number MUST be provided. Contact details that are specific to the role/location/service. 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. This is not the personnel contact number of the Practitioner, it the contact number for the practitioner in this role and may be the phone number of the clinic, main or branch surgery.
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.
| |||||||||||||||||||||
system | Σ I | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.telecom.system phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point. ContactPointSystem (required)Constraints
| |||||||||||||||||||||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.telecom.value The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
| |||||||||||||||||||||
use | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.telecom.use home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point. ContactPointUse (required)Constraints
| |||||||||||||||||||||
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdPractitionerRole.telecom.rank Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
| |||||||||||||||||||||
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.telecom.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
| |||||||||||||||||||||
availableTime | 0..* | BackboneElement | There are no (further) constraints on this element Element IdPractitionerRole.availableTime Times the Service Site is available DefinitionA collection of times the practitioner is available or performing this role at the location and/or healthcareservice. More detailed availability information may be provided in associated Schedule/Slot resources.
| ||||||||||||||||||||||
daysOfWeek | 0..* | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.availableTime.daysOfWeek mon | tue | wed | thu | fri | sat | sun DefinitionIndicates which days of the week are available between the start and end Times. Note that FHIR strings SHALL NOT exceed 1MB in size The days of the week. DaysOfWeek (required)Constraints
| ||||||||||||||||||||||
allDay | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitionerRole.availableTime.allDay Always available? e.g. 24 hour service DefinitionIs this always available? (hence times are irrelevant) e.g. 24 hour service.
| ||||||||||||||||||||||
availableStartTime | 0..1 | time | There are no (further) constraints on this element Element IdPractitionerRole.availableTime.availableStartTime Opening time of day (ignored if allDay = true) DefinitionThe opening time of day. Note: If the AllDay flag is set, then this time is ignored. The timezone is expected to be for where this HealthcareService is provided at.
| ||||||||||||||||||||||
availableEndTime | 0..1 | time | There are no (further) constraints on this element Element IdPractitionerRole.availableTime.availableEndTime Closing time of day (ignored if allDay = true) DefinitionThe closing time of day. Note: If the AllDay flag is set, then this time is ignored. The timezone is expected to be for where this HealthcareService is provided at.
| ||||||||||||||||||||||
notAvailable | 0..* | BackboneElement | There are no (further) constraints on this element Element IdPractitionerRole.notAvailable Not available during this time due to provided reason DefinitionThe practitioner is not available or performing this role during this period of time due to the provided reason.
| ||||||||||||||||||||||
description | 1..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.notAvailable.description Reason presented to the user explaining why time not available DefinitionThe reason that can be presented to the user as to why this time is not available. Note that FHIR strings SHALL NOT exceed 1MB in size
| ||||||||||||||||||||||
during | I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.notAvailable.during Service not available from this date DefinitionService is not available (seasonally or for a public holiday) from this date. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
| |||||||||||||||||||||
availabilityExceptions | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.availabilityExceptions Description of availability exceptions DefinitionA description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. Note that FHIR strings SHALL NOT exceed 1MB in size
| ||||||||||||||||||||||
endpoint | I | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element IdPractitionerRole.endpoint Technical endpoints providing access to services operated for the practitioner with this role DefinitionTechnical endpoints providing access to services operated for the practitioner with this role. Organizations have multiple systems that provide various services and ,ay 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. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
| |||||||||||||||||||||
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.endpoint.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
| |||||||||||||||||||||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdPractitionerRole.endpoint.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
| |||||||||||||||||||||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdPractitionerRole.endpoint.identifier Logical reference, when literal reference is not known DefinitionAn 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. 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).
| |||||||||||||||||||||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.endpoint.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
| |||||||||||||||||||||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPractitionerRole.endpoint.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
| |||||||||||||||||||||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdPractitionerRole.endpoint.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
| |||||||||||||||||||||
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.endpoint.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
| |||||||||||||||||||||
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.endpoint.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
| |||||||||||||||||||||
assigner | Σ I | 0..1 | Reference(UK Core Organization) | There are no (further) constraints on this element Element IdPractitionerRole.endpoint.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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. Reference(UK Core Organization) Constraints
| |||||||||||||||||||||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.endpoint.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
from UK Core PractitionerRole
PractitionerRole | I | PractitionerRole | Element IdPractitionerRole Roles/organizations the practitioner is associated with DefinitionA specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
| ||||||||||||||||||||||
extension | I | 0..* | Extension | Element IdPractitionerRole.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Constraints
| |||||||||||||||||||||
costCentre | S I | 0..1 | Extension(Complex) | Element IdPractitionerRole.extension:costCentre Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. Extension(Complex) Extension URLhttps://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-Account-code Constraints
| |||||||||||||||||||||
identifier | S Σ | 0..* | Identifier | Element IdPractitionerRole.identifier An identifier that applies to this person in this role. Definition
The SDS Role Profile Code should be sourced from NHS Identity (SmartCard), this is also held within the Spine Directory Service LDAP database. Holds NHS BSA spurious codes which are role specific Doctor Index Number (DIN)) codes. NHS BSA spurious codes are issued when a doctor issues medication outside of their normal role, normally at another organisation. In the example below, the doctor is working in a secondary role (with SDS Role Id of 100102238986), as this a has a spurious code of 2345213. If the doctor was prescribing in their primary role this spurious code would be absent.
Often, specific identities are assigned for the agent. Unordered, Open, by system(Value) Constraints
| |||||||||||||||||||||
(All Slices) | There are no (further) constraints on this element | ||||||||||||||||||||||||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
| |||||||||||||||||||||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPractitionerRole.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
| |||||||||||||||||||||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element IdPractitionerRole.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
| |||||||||||||||||||||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
| |||||||||||||||||||||
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
| |||||||||||||||||||||
assigner | Σ I | 0..1 | Reference(UK Core Organization) | There are no (further) constraints on this element Element IdPractitionerRole.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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. Reference(UK Core Organization) Constraints
| |||||||||||||||||||||
sdsRoleProfileID | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdPractitionerRole.identifier:sdsRoleProfileID An identifier that applies to this person in this role. DefinitionAn identifier that applies to this person in this role. Often, specific identities are assigned for the agent.
| |||||||||||||||||||||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.identifier:sdsRoleProfileID.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
| |||||||||||||||||||||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPractitionerRole.identifier:sdsRoleProfileID.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
| |||||||||||||||||||||
system | Σ | 1..1 | uriFixed Value | Element IdPractitionerRole.identifier:sdsRoleProfileID.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
https://fhir.nhs.uk/Id/sds-role-profile-id
| |||||||||||||||||||||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.identifier:sdsRoleProfileID.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
| |||||||||||||||||||||
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.identifier:sdsRoleProfileID.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
| |||||||||||||||||||||
assigner | Σ I | 0..1 | Reference(UK Core Organization) | There are no (further) constraints on this element Element IdPractitionerRole.identifier:sdsRoleProfileID.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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. Reference(UK Core Organization) Constraints
| |||||||||||||||||||||
nhsbsaSpuriousCode | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdPractitionerRole.identifier:nhsbsaSpuriousCode An identifier that applies to this person in this role. DefinitionAn identifier that applies to this person in this role. Often, specific identities are assigned for the agent.
| |||||||||||||||||||||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.identifier:nhsbsaSpuriousCode.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
| |||||||||||||||||||||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPractitionerRole.identifier:nhsbsaSpuriousCode.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
| |||||||||||||||||||||
system | Σ | 1..1 | uriFixed Value | Element IdPractitionerRole.identifier:nhsbsaSpuriousCode.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
https://fhir.hl7.org.uk/Id/nhsbsa-spurious-code
| |||||||||||||||||||||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.identifier:nhsbsaSpuriousCode.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
| |||||||||||||||||||||
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.identifier:nhsbsaSpuriousCode.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
| |||||||||||||||||||||
assigner | Σ I | 0..1 | Reference(UK Core Organization) | There are no (further) constraints on this element Element IdPractitionerRole.identifier:nhsbsaSpuriousCode.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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. Reference(UK Core Organization) Constraints
| |||||||||||||||||||||
active | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitionerRole.active Whether this practitioner role record is in active use DefinitionWhether this practitioner role record is in active use. 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. 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. This resource is generally assumed to be active if no value is provided for the active element
| |||||||||||||||||||||
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.period The period during which the practitioner is authorized to perform in these role(s) DefinitionThe period during which the person is authorized to act as a practitioner in these role(s) for the organization. Even after the agencies is revoked, the fact that it existed must still be recorded. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
| |||||||||||||||||||||
practitioner | S Σ I | 0..1 | Reference(NHSDigitalPractitioner) | Element IdPractitionerRole.practitioner Practitioner that is able to provide the defined services for the organization DefinitionThis MUST either be a reference to a Practitioner resource or an identifier reference plus a display. In both cases the referenced resource or identfier reference should contain a professional code. It is recommended an identifier reference and display (practioner full name) is included. This identifier should be the Practitioner's primary professional code (see
For EPS, currently a Resource reference is required.
References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(NHSDigitalPractitioner) Constraints
| |||||||||||||||||||||
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.practitioner.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
| |||||||||||||||||||||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdPractitionerRole.practitioner.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
| |||||||||||||||||||||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdPractitionerRole.practitioner.identifier Logical reference, when literal reference is not known DefinitionAn 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. 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).
| |||||||||||||||||||||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.practitioner.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
| |||||||||||||||||||||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPractitionerRole.practitioner.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
| |||||||||||||||||||||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdPractitionerRole.practitioner.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
| |||||||||||||||||||||
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.practitioner.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
| |||||||||||||||||||||
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.practitioner.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
| |||||||||||||||||||||
assigner | Σ I | 0..1 | Reference(UK Core Organization) | There are no (further) constraints on this element Element IdPractitionerRole.practitioner.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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. Reference(UK Core Organization) Constraints
| |||||||||||||||||||||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.practitioner.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| |||||||||||||||||||||
organization | S Σ I | 0..1 | Reference(NHSDigitalOrganization) | Element IdPractitionerRole.organization Organization where the roles are available DefinitionThis MUST either be a reference to a Organization resource or an identifier reference. In both cases the reference must contain an ANANA/ODS organisation code. organisation resource referencesIt is recommended an identifier reference is included.
Optionally Resource reference can be provided. This is required in the current version of EPS but this will be changed to supporting the identifier reference only.
References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(NHSDigitalOrganization) Constraints
| |||||||||||||||||||||
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.organization.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
| |||||||||||||||||||||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdPractitionerRole.organization.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
| |||||||||||||||||||||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdPractitionerRole.organization.identifier Logical reference, when literal reference is not known DefinitionAn 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. 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).
| |||||||||||||||||||||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.organization.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
| |||||||||||||||||||||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPractitionerRole.organization.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
| |||||||||||||||||||||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element IdPractitionerRole.organization.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
| |||||||||||||||||||||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.organization.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
| |||||||||||||||||||||
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.organization.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
| |||||||||||||||||||||
assigner | Σ I | 0..1 | Reference(UK Core Organization) | There are no (further) constraints on this element Element IdPractitionerRole.organization.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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. Reference(UK Core Organization) Constraints
| |||||||||||||||||||||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.organization.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| |||||||||||||||||||||
code | S Σ | 0..* | CodeableConcept | Element IdPractitionerRole.code Roles which this practitioner may perform DefinitionOnly supply if this is known from SmartCard/CIS2 data.
The previous system for this entry was Need to know what authority the practitioner has - what can they do? A person may have more than one role. The role a person plays representing an organization. PractitionerRole (example)Constraints
| |||||||||||||||||||||
coding | Σ | 1..* | Coding | Element IdPractitionerRole.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by system(Value) Constraints
| |||||||||||||||||||||
(All Slices) | There are no (further) constraints on this element | ||||||||||||||||||||||||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element IdPractitionerRole.code.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
| |||||||||||||||||||||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.code.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
| |||||||||||||||||||||
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdPractitionerRole.code.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||||||||||||||||||||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.code.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||||||||||||||||||||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitionerRole.code.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
| |||||||||||||||||||||
sdsJobRoleCode | S Σ | 0..1 | Coding | Element IdPractitionerRole.code.coding:sdsJobRoleCode SDS Job Role Code DefinitionThis value should be sourced from either APIM OAuth2 userinfo endpoint, SDS LDAP or CIS2/SmartCard details. The CodeSystem is variable and is not present in this Implementation Guide. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
| |||||||||||||||||||||
system | Σ | 0..1 | uriFixed Value | Element IdPractitionerRole.code.coding:sdsJobRoleCode.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
https://fhir.nhs.uk/CodeSystem/NHSDigital-SDS-JobRoleCode
| |||||||||||||||||||||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:sdsJobRoleCode.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
| |||||||||||||||||||||
code | Σ | 0..1 | code | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:sdsJobRoleCode.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||||||||||||||||||||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:sdsJobRoleCode.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||||||||||||||||||||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:sdsJobRoleCode.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
| |||||||||||||||||||||
SDSJobRoleName | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:SDSJobRoleName Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
| |||||||||||||||||||||
system | Σ | 0..1 | uriFixed Value | Element IdPractitionerRole.code.coding:SDSJobRoleName.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
https://fhir.hl7.org.uk/CodeSystem/UKCore-SDSJobRoleName
| |||||||||||||||||||||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:SDSJobRoleName.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
| |||||||||||||||||||||
code | Σ | 0..1 | code | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:SDSJobRoleName.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||||||||||||||||||||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:SDSJobRoleName.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||||||||||||||||||||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:SDSJobRoleName.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
| |||||||||||||||||||||
ukCoreSNOMEDCT | Σ | 0..* | CodingBinding | Element IdPractitionerRole.code.coding:ukCoreSNOMEDCT Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. UKCorePractitionerRoleCode (preferred) Constraints
| |||||||||||||||||||||
system | Σ | 0..1 | uriFixed Value | Element IdPractitionerRole.code.coding:ukCoreSNOMEDCT.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
http://snomed.info/sct
| |||||||||||||||||||||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:ukCoreSNOMEDCT.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
| |||||||||||||||||||||
code | Σ | 0..1 | code | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:ukCoreSNOMEDCT.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||||||||||||||||||||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:ukCoreSNOMEDCT.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||||||||||||||||||||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitionerRole.code.coding:ukCoreSNOMEDCT.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
| |||||||||||||||||||||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.code.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
| |||||||||||||||||||||
specialty | S Σ | 0..* | CodeableConceptBinding | Element IdPractitionerRole.specialty Specific specialty of the practitioner DefinitionThis is should be the specialty linked to the role and is not necessarily the practitioners main specialty.
Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Specific specialty associated with the agency. UKCorePracticeSettingCode (extensible)Constraints
| |||||||||||||||||||||
coding | Σ | 1..* | Coding | Element IdPractitionerRole.specialty.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by system(Value) Constraints
| |||||||||||||||||||||
(All Slices) | There are no (further) constraints on this element | ||||||||||||||||||||||||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element IdPractitionerRole.specialty.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
| |||||||||||||||||||||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.specialty.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
| |||||||||||||||||||||
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdPractitionerRole.specialty.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||||||||||||||||||||
display | Σ | 1..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.specialty.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||||||||||||||||||||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitionerRole.specialty.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
| |||||||||||||||||||||
SNOMEDSpecialty | S Σ | 0..* | CodingBinding | Element IdPractitionerRole.specialty.coding:SNOMEDSpecialty Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Specific specialty associated with the agency. PracticeSettingCodeValueSet (preferred)Constraints
| |||||||||||||||||||||
system | Σ | 0..1 | uriFixed Value | Element IdPractitionerRole.specialty.coding:SNOMEDSpecialty.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
http://snomed.info/sct
| |||||||||||||||||||||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.specialty.coding:SNOMEDSpecialty.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
| |||||||||||||||||||||
code | Σ | 0..1 | code | There are no (further) constraints on this element Element IdPractitionerRole.specialty.coding:SNOMEDSpecialty.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||||||||||||||||||||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.specialty.coding:SNOMEDSpecialty.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||||||||||||||||||||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitionerRole.specialty.coding:SNOMEDSpecialty.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
| |||||||||||||||||||||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.specialty.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
| |||||||||||||||||||||
location | Σ I | 0..* | Reference(NHSDigitalLocation) | Element IdPractitionerRole.location The location(s) at which this practitioner provides care DefinitionThe contact address for the practitioner for the service they are providing in this role. This will often be the surgery address, clinic or service address. If using ODS Codes, the address on ODS must be checked to ensure it is correct. If the address is not correct, then Resource reference MUST be supplied.
For EPS, currently a Resource reference is required.
References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
| |||||||||||||||||||||
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.location.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
| |||||||||||||||||||||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdPractitionerRole.location.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
| |||||||||||||||||||||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdPractitionerRole.location.identifier Logical reference, when literal reference is not known DefinitionAn 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. 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).
| |||||||||||||||||||||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.location.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
| |||||||||||||||||||||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPractitionerRole.location.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
| |||||||||||||||||||||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element IdPractitionerRole.location.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
| |||||||||||||||||||||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.location.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
| |||||||||||||||||||||
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.location.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
| |||||||||||||||||||||
assigner | Σ I | 0..1 | Reference(UK Core Organization) | There are no (further) constraints on this element Element IdPractitionerRole.location.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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. Reference(UK Core Organization) Constraints
| |||||||||||||||||||||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.location.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| |||||||||||||||||||||
healthcareService | S I | 0..1 | Reference(NHSDigitalHealthcareService) | Element IdPractitionerRole.healthcareService The list of healthcare services that this worker provides for this role's Organization/Location(s) DefinitionSHOULD be provided for a practitioner in secondary care and will be a reference to clinic or service. This referenced resource or the identifier reference SHOULD contain a ODS/ANANA identifier. In secondary care Electronic Prescription Service (EPS) this will also be called prescribing cost centre. This is used for reimbursements from NHS BSA. In secondary care the healthchare/service cost centre may also be the ODS code for the clinic. healthcareService Resource referenceAn identifier reference MUST be included. For secondary care organisations this will be the ODS/ANANA Cost Centre code given to a clinic.
Optionally Resource reference can be provided. This is required in the current version of EPS but this will be changed to supporting the identifier reference only.
References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(NHSDigitalHealthcareService) Constraints
| |||||||||||||||||||||
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.healthcareService.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
| |||||||||||||||||||||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdPractitionerRole.healthcareService.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
| |||||||||||||||||||||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdPractitionerRole.healthcareService.identifier Logical reference, when literal reference is not known DefinitionAn 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. 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).
| |||||||||||||||||||||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.healthcareService.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
| |||||||||||||||||||||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPractitionerRole.healthcareService.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
| |||||||||||||||||||||
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element IdPractitionerRole.healthcareService.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
| |||||||||||||||||||||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.healthcareService.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
| |||||||||||||||||||||
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.healthcareService.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
| |||||||||||||||||||||
assigner | Σ I | 0..1 | Reference(UK Core Organization) | There are no (further) constraints on this element Element IdPractitionerRole.healthcareService.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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. Reference(UK Core Organization) Constraints
| |||||||||||||||||||||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.healthcareService.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| |||||||||||||||||||||
telecom | S Σ I | 0..* | ContactPoint | Element IdPractitionerRole.telecom Contact details that are specific to the role/location/service DefinitionAt least one telecom number MUST be provided. Contact details that are specific to the role/location/service. 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. This is not the personnel contact number of the Practitioner, it the contact number for the practitioner in this role and may be the phone number of the clinic, main or branch surgery.
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.
| |||||||||||||||||||||
system | Σ I | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.telecom.system phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point. ContactPointSystem (required)Constraints
| |||||||||||||||||||||
value | Σ | 1..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.telecom.value The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
| |||||||||||||||||||||
use | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.telecom.use home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point. ContactPointUse (required)Constraints
| |||||||||||||||||||||
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdPractitionerRole.telecom.rank Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
| |||||||||||||||||||||
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.telecom.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
| |||||||||||||||||||||
availableTime | 0..* | BackboneElement | There are no (further) constraints on this element Element IdPractitionerRole.availableTime Times the Service Site is available DefinitionA collection of times the practitioner is available or performing this role at the location and/or healthcareservice. More detailed availability information may be provided in associated Schedule/Slot resources.
| ||||||||||||||||||||||
daysOfWeek | 0..* | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.availableTime.daysOfWeek mon | tue | wed | thu | fri | sat | sun DefinitionIndicates which days of the week are available between the start and end Times. Note that FHIR strings SHALL NOT exceed 1MB in size The days of the week. DaysOfWeek (required)Constraints
| ||||||||||||||||||||||
allDay | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitionerRole.availableTime.allDay Always available? e.g. 24 hour service DefinitionIs this always available? (hence times are irrelevant) e.g. 24 hour service.
| ||||||||||||||||||||||
availableStartTime | 0..1 | time | There are no (further) constraints on this element Element IdPractitionerRole.availableTime.availableStartTime Opening time of day (ignored if allDay = true) DefinitionThe opening time of day. Note: If the AllDay flag is set, then this time is ignored. The timezone is expected to be for where this HealthcareService is provided at.
| ||||||||||||||||||||||
availableEndTime | 0..1 | time | There are no (further) constraints on this element Element IdPractitionerRole.availableTime.availableEndTime Closing time of day (ignored if allDay = true) DefinitionThe closing time of day. Note: If the AllDay flag is set, then this time is ignored. The timezone is expected to be for where this HealthcareService is provided at.
| ||||||||||||||||||||||
notAvailable | 0..* | BackboneElement | There are no (further) constraints on this element Element IdPractitionerRole.notAvailable Not available during this time due to provided reason DefinitionThe practitioner is not available or performing this role during this period of time due to the provided reason.
| ||||||||||||||||||||||
description | 1..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.notAvailable.description Reason presented to the user explaining why time not available DefinitionThe reason that can be presented to the user as to why this time is not available. Note that FHIR strings SHALL NOT exceed 1MB in size
| ||||||||||||||||||||||
during | I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.notAvailable.during Service not available from this date DefinitionService is not available (seasonally or for a public holiday) from this date. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
| |||||||||||||||||||||
availabilityExceptions | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.availabilityExceptions Description of availability exceptions DefinitionA description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. Note that FHIR strings SHALL NOT exceed 1MB in size
| ||||||||||||||||||||||
endpoint | I | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element IdPractitionerRole.endpoint Technical endpoints providing access to services operated for the practitioner with this role DefinitionTechnical endpoints providing access to services operated for the practitioner with this role. Organizations have multiple systems that provide various services and ,ay 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. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
| |||||||||||||||||||||
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.endpoint.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
| |||||||||||||||||||||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdPractitionerRole.endpoint.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
| |||||||||||||||||||||
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdPractitionerRole.endpoint.identifier Logical reference, when literal reference is not known DefinitionAn 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. 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).
| |||||||||||||||||||||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.endpoint.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
| |||||||||||||||||||||
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPractitionerRole.endpoint.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
| |||||||||||||||||||||
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdPractitionerRole.endpoint.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
| |||||||||||||||||||||
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.endpoint.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
| |||||||||||||||||||||
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.endpoint.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
| |||||||||||||||||||||
assigner | Σ I | 0..1 | Reference(UK Core Organization) | There are no (further) constraints on this element Element IdPractitionerRole.endpoint.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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. Reference(UK Core Organization) Constraints
| |||||||||||||||||||||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.endpoint.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
key | human | severity | expression |
---|---|---|---|
role-spurious | Spurious Code format must be G6NNNNNN or G7NNNNNN | warning | identifier.where(system='https://fhir.hl7.org.uk/Id/nhsbsa-spurious-code').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/nhsbsa-spurious-code').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/nhsbsa-spurious-code').value.matches('^[G]{1}[67]{1}[0-9]{6}$')) |
role-sds-role-profile | SDS Role Profile Id must be 12 digits | error | identifier.where(system='https://fhir.nhs.uk/Id/sds-role-profile-id').exists().not() or (identifier.where(system='https://fhir.nhs.uk/Id/sds-role-profile-id').exists() and identifier.where(system='https://fhir.nhs.uk/Id/sds-role-profile-id').value.matches('^[0-9]{12}$')) |
nhsd-2 | An identifier reference or resource reference must be provided | warning | (reference.exists() or identifier.exists()) |
role-nmc | NMC must be of the format NNANNNNA | warning | identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/nmc-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/nmc-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/nmc-number').value.matches('^[0-9]{2}[A-Z]{1}[0-9]{4}[A-Z]{1}$')) |
role-gmp | GMP must be of the format GNNNNNNN and not be a spurious code (starts with G6 or G7) | error | identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/gmp-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/gmp-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/gmp-number').value.matches('^[G]{1}[01234589]{1}[0-9]{6}$')) |
role-gmc | GMC must be of the format CNNNNNNN | error | identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/gmc-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/gmc-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/gmc-number').value.matches('^[C]{1}[0-9]{7}$')) |
role-gphc | GPHC must be of the format NNNNNNN | warning | identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/gphc-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/gphc-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/gphc-number').value.matches('^[0-9]{7}$')) |
role-hcpc | HCPC must be of the format AANNNNNN | warning | identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/hcpc-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/hcpc-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/hcpc-number').value.matches('^[A-Z]{2}[0-9]{6}$')) |
role-din | DIN format must be NNNNNN | warning | identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/din-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/din-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/din-number').value.matches('^[0-9]{6}$')) |
role-sds-user-numeric | sds-user-id must be numeric | error | identifier.where(system='https://fhir.nhs.uk/Id/sds-user-id').exists().not() or (identifier.where(system='https://fhir.nhs.uk/Id/sds-user-id').exists() and identifier.where(system='https://fhir.nhs.uk/Id/sds-user-id').value.matches('^[0-9]+$')) |
role-gmcreferencenumber | GMC Reference Number must be of the format NNNNNNN | error | identifier.where(system='https://fhir.hl7.org.uk/Id/gmc-reference-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/gphc-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/gmc-reference-number').value.matches('^[0-9]{7}$')) |
nacs-code-retired | NACS (/ODS) Practitioner Identifier is retired in NHS FHIR and should not be used. Please use the actual naming system instead (e,g, https://fhir.hl7.org.uk/Id/gmc-number, https://fhir.hl7.org.uk/Id/gmp-number, etc). | warning | identifier.where(system='https://fhir.hl7.org.uk/Id/professional-code').exists().not() |
nhsd-1 | PractitionerRole.organization - An identifier reference or resource reference should be provided | warning | (reference.exists() or identifier.exists()) |
nhsd-3 | PractitionerRole.location - An identifier or resource reference must be provided | error | (reference.exists() or identifier.exists()) |
nhsd-4 | PractitionerRole.healthcareService - An identifier reference or resource reference must be provided | error | (reference.exists() or (identifier.exists())) |
Constraint Profiles
name | profile | purpose |
---|---|---|
NHSDigitalPractitionerRoleEPSLegal | https://fhir.nhs.uk/StructureDefinition/NHSDigital-PractitionerRole-EPSLegal | Constraint profile for EPS MedicationRequest which enforces the legal requirement for prescriptions |
NHSDigitalPractitionerRoleMinimal | https://fhir.nhs.uk/StructureDefinition/NHSDigital-PractitionerRole-Minimal | Constraint profile for which enforces practitioner and organization elements in contained resources, |
NHSDigitalPractitionerRoleSDS | https://fhir.nhs.uk/StructureDefinition/NHSDigital-PractitionerRole-SDS | Constraint profile for Electronic Prescription System which enforces practitioner, organization, sds role code, sds user profile id and telecom elements in contained resources, |
Definition
A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
Constraints
role-spurious (WARNING) Spurious Code format must be G6NNNNNN or G7NNNNNN
role-sds-role-profile (ERROR) SDS Role Profile Id must be 12 digits
extension:costCentre
Element Id | PractitionerRole.extension:costCentre |
Cardinality | 0..1 |
Slice Name | costCentre |
type | Extension(ExtensionNHSDigitalAccountCode) |
Definition
Optional Extension Element - found in all resources.
identifier
Element Id | PractitionerRole.identifier |
Cardinality | 0..* |
Slicing | OPEN discriminator - VALUE system |
type | Identifier |
Definition
FHIR identifier | OID/HL7v3 | HL7v2 ITK | Format | Description | Professional Code | Prescribing Code |
---|---|---|---|---|---|---|
https://fhir.hl7.org.uk/Id/nhsbsa-spurious-code | G[67]NNNNNN | NHS BSA Spurious Code GENERAL MEDICAL PRACTITIONER PPD CODE | No | Yes | ||
https://fhir.nhs.uk/Id/sds-role-profile-id | 1.2.826.0.1285.0.2.0.67 | 12 digits | SDS Role Profile Code | No | No |
The SDS Role Profile Code should be sourced from NHS Identity (SmartCard), this is also held within the Spine Directory Service LDAP database.
Holds NHS BSA spurious codes which are role specific Doctor Index Number (DIN)) codes. NHS BSA spurious codes are issued when a doctor issues medication outside of their normal role, normally at another organisation. In the example below, the doctor is working in a secondary role (with SDS Role Id of 100102238986), as this a has a spurious code of 2345213. If the doctor was prescribing in their primary role this spurious code would be absent.
{ "resourceType": "PractitionerRole", ... "identifier": [ { "system": "https://fhir.nhs.uk/Id/sds-role-profile-id", "value": "100102238986" }, { "system": "https://fhir.hl7.org.uk/Id/nhsbsa-spurious-code", "value": "2345213" } ], ... }
Requirements
Often, specific identities are assigned for the agent.
identifier:sdsRoleProfileID
Element Id | PractitionerRole.identifier:sdsRoleProfileID |
Cardinality | 0..1 |
Slice Name | sdsRoleProfileID |
type | Identifier |
Definition
An identifier that applies to this person in this role.
Requirements
Often, specific identities are assigned for the agent.
identifier:sdsRoleProfileID.system
Element Id | PractitionerRole.identifier:sdsRoleProfileID.system |
Cardinality | 1..1 |
Fixed Value | https://fhir.nhs.uk/Id/sds-role-profile-id |
type | uri |
Definition
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
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.
Comment
Identifier.system is always case sensitive.
identifier:nhsbsaSpuriousCode
Element Id | PractitionerRole.identifier:nhsbsaSpuriousCode |
Cardinality | 0..1 |
Slice Name | nhsbsaSpuriousCode |
type | Identifier |
Definition
An identifier that applies to this person in this role.
Requirements
Often, specific identities are assigned for the agent.
identifier:nhsbsaSpuriousCode.system
Element Id | PractitionerRole.identifier:nhsbsaSpuriousCode.system |
Cardinality | 1..1 |
Fixed Value | https://fhir.hl7.org.uk/Id/nhsbsa-spurious-code |
type | uri |
Definition
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
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.
Comment
Identifier.system is always case sensitive.
practitioner
Element Id | PractitionerRole.practitioner |
Cardinality | 0..1 |
type | Reference(NHSDigitalPractitioner) |
Definition
This MUST either be a reference to a Practitioner resource or an identifier reference plus a display. In both cases the referenced resource or identifier reference should contain a professional code.
It is recommended an identifier reference and display (practitioner full name) is included. This identifier should be the Practitioner's primary professional code (see NHSDigital-Practitioner
for details on professional codes).
"practitioner": { "display": "Dr Smith", "identifier": { "system": "https://fhir.hl7.org.uk/Id/gmc-number", "value": "C9876543" } },
For EPS, currently a Resource reference is required.
"practitioner": { "reference": "urn:uuid:1557E58E-3B1E-41DD-B3B5-D4D393DC5A3D", "display": "Dr Smith" },
Constraints
- nhsd-2 (WARNING) An identifier reference or resource reference must be provided
- role-nmc (WARNING) NMC must be of the format NNANNNNA
- role-gmp (ERROR) GMP must be of the format GNNNNNNN and not be a spurious code (starts with G6 or G7)
- role-gmc (ERROR) GMC must be of the format CNNNNNNN
- role-gphc (WARNING) GPHC must be of the format NNNNNNN
- role-hcpc (WARNING) HCPC must be of the format AANNNNNN
- role-din (WARNING) DIN format must be NNNNNN
- role-sds-user-numeric (ERROR) sds-user-id must be numeric
- role-gmcreferencenumber (ERROR) GMC Reference Number must be of the format NNNNNNN
- nacs-code-retired (WARNING) NACS (/ODS) Practitioner Identifier is retired in NHS FHIR and should not be used. Please use the actual naming system instead (e,g, https://fhir.hl7.org.uk/Id/gmc-number, https://fhir.hl7.org.uk/Id/gmp-number, etc).
organization
Element Id | PractitionerRole.organization |
Cardinality | 0..1 |
type | Reference(NHSDigitalOrganization) |
Definition
This MUST either be a reference to a Organization resource or an identifier reference. In both cases the reference must contain an ANANA/ODS organisation code.
organisation resource references
It is recommended an identifier reference is included.
"organization": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RBA" }, "display": "TAUNTON AND SOMERSET NHS FOUNDATION TRUST" }
Optionally Resource reference can be provided. This is required in the current version of EPS but this will be changed to supporting the identifier reference only.
"organization": { "reference": "urn:uuid:17c4270d-6966-4788-8cbc-1d1d63536b25", "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RBA" }, "display": "TAUNTON AND SOMERSET NHS FOUNDATION TRUST" }
Constraints
- nhsd-1 (WARNING) PractitionerRole.organization - An identifier reference or resource reference should be provided
code
Element Id | PractitionerRole.code |
Cardinality | 0..* |
Terminology Binding | NHSDigitalPractitionerRoleCode (Extensible) |
type | CodeableConcept |
Definition
Only supply if this is known from SmartCard/CIS2 data.
"code": [ { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/NHSDigital-SDS-JobRoleCode", "code": "S0030:G0100:R0620" } ] } ],
The previous system for this entry was https://fhir.hl7org.uk/CodeSystem/UKCore-SDSJobRoleName
, this has been retired and https://fhir.nhs.uk/CodeSystem/NHSDigital-SDS-JobRoleCode
should be used instead.
Requirements
Need to know what authority the practitioner has - what can they do?
Comment
A person may have more than one role.
code.coding:sdsJobRoleCode
Element Id | PractitionerRole.code.coding:sdsJobRoleCode |
Cardinality | 0..1 |
Slice Name | sdsJobRoleCode |
type | Coding |
Definition
This value should be sourced from either APIM OAuth2 userinfo endpoint, SDS LDAP or CIS2/SmartCard details.
The CodeSystem is variable and is not present in this Implementation Guide.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
code.coding:sdsJobRoleCode.system
Element Id | PractitionerRole.code.coding:sdsJobRoleCode.system |
Cardinality | 0..1 |
Fixed Value | https://fhir.nhs.uk/CodeSystem/NHSDigital-SDS-JobRoleCode |
type | uri |
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
specialty
Element Id | PractitionerRole.specialty |
Cardinality | 0..* |
Terminology Binding | PracticeSettingCodeValueSet (Preferred) Specific specialty associated with the agency. |
type | CodeableConcept |
Definition
This is should be the specialty linked to the role and is not necessarily the practitioners main specialty.
This can be supplemented by SNOMED CT codes from PracticeSettingCodeValueSet, no ConceptMap currently exists for mapping between the two.
"specialty": [ { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/NHSDataModelAndDictionary-clinical-specialty", "code": "100", "display": "GENERAL SURGERY" } ] } ],
specialty.coding:NHSDataDictionarySpecialty
Element Id | PractitionerRole.specialty.coding:NHSDataDictionarySpecialty |
Cardinality | 0..* |
Terminology Binding | NHSDataDictionaryMainClinicalSpecialty (Required) NHS Data Dictionary Specialty |
Slice Name | NHSDataDictionarySpecialty |
type | Coding |
Definition
A reference to a code defined by a terminology system.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
specialty.coding:NHSDataDictionarySpecialty.system
Element Id | PractitionerRole.specialty.coding:NHSDataDictionarySpecialty.system |
Cardinality | 0..1 |
Fixed Value | https://fhir.nhs.uk/CodeSystem/NHSDataModelAndDictionary-clinical-specialty |
type | uri |
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
specialty.coding:SNOMEDSpecialty
Element Id | PractitionerRole.specialty.coding:SNOMEDSpecialty |
Cardinality | 0..* |
Terminology Binding | PracticeSettingCodeValueSet (Preferred) Specific specialty associated with the agency. |
Slice Name | SNOMEDSpecialty |
type | Coding |
Definition
A reference to a code defined by a terminology system.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
specialty.coding:SNOMEDSpecialty.system
Element Id | PractitionerRole.specialty.coding:SNOMEDSpecialty.system |
Cardinality | 0..1 |
Fixed Value | http://snomed.info/sct |
type | uri |
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
location
Element Id | PractitionerRole.location |
Cardinality | 0..* |
type | Reference(NHSDigitalLocation) |
Definition
The contact address for the practitioner for the service they are providing in this role. This will often be the surgery address, clinic or service address.
If using ODS Codes, the address on ODS must be checked to ensure it is correct. If the address is not correct, then Resource reference MUST be supplied.
"location": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RCB55" } "display": "YORK HOSPITAL" } ]
For EPS, currently a Resource reference is required.
"location": [ { "reference": "urn:uuid:ecc2db8e-3757-4758-a4f1-7f4c7e06662f", "display": "YORK HOSPITAL" } ]
Constraints
- nhsd-3 (ERROR) PractitionerRole.location - An identifier or resource reference must be provided
healthcareService
Element Id | PractitionerRole.healthcareService |
Cardinality | 0..1 |
type | Reference(NHSDigitalHealthcareService) |
Definition
SHOULD be provided for a practitioner in secondary care and will be a reference to clinic or service. This referenced resource or the identifier reference SHOULD contain a ODS/ANANA identifier. In secondary care Electronic Prescription Service (EPS) this will also be called prescribing cost centre. This is used for reimbursements from NHS BSA. In secondary care the healthcare/service cost centre may also be the ODS code for the clinic.
healthcareService Resource reference
An identifier reference MUST be included. For secondary care organisations this will be the ODS/ANANA Cost Centre code given to a clinic.
"healthcareService": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "A99968" } "display": "SOMERSET BOWEL CANCER SCREENING CENTRE" } ]
Optionally Resource reference can be provided. This is required in the current version of EPS but this will be changed to supporting the identifier reference only.
"healthcareService": [ { "reference": "urn:uuid:54b0506d-49af-4245-9d40-d7d64902055e", "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "A99968" } "display": "SOMERSET BOWEL CANCER SCREENING CENTRE" } ]
Constraints
- nhsd-4 (ERROR) PractitionerRole.healthcareService - An identifier reference or resource reference must be provided
telecom
Element Id | PractitionerRole.telecom |
Cardinality | 0..* |
type | ContactPoint |
Definition
At least one telecom number MUST be provided. Contact details that are specific to the role/location/service. 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.
This is not the personnel contact number of the Practitioner, it the contact number for the practitioner in this role and may be the phone number of the clinic, main or branch surgery.
"telecom": [ { "system": "phone", "value": "01234567890", "use": "work" } ]
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.