Profile: CareConnect-GPC-PractitionerRole-1
CareConnect-GPC-PractitionerRole-1 (PractitionerRole) | C | PractitionerRole | |
id | Σ | 0..1 | id |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | C | 0..1 | Narrative |
contained | 0..* | Resource | |
extension | 0..* | Extension | |
modifierExtension | ?! | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
id | 0..1 | string | |
extension | 0..* | Extension | |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference(CareConnect-GPC-Organization-1) |
active | Σ | 0..1 | boolean |
period | Σ | 0..1 | Period |
practitioner | Σ | 0..1 | Reference(CareConnect-GPC-Practitioner-1) |
organization | Σ | 0..1 | Reference(CareConnect-GPC-Organization-1) |
code | Σ | 0..* | CodeableConcept |
sdsJobRoleName | Σ | 0..1 | CodeableConceptBinding |
id | 0..1 | string | |
extension | 0..* | Extension | |
coding | Σ | 1..1 | Coding |
id | 0..1 | string | |
extension | 0..* | Extension | |
system | Σ | 1..1 | uriAuto Value |
version | Σ | 0..0 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..0 | boolean |
text | Σ | 0..1 | string |
specialty | Σ | 0..* | CodeableConceptBinding |
location | Σ | 0..* | Reference(CareConnect-GPC-Location-1) |
healthcareService | 0..* | Reference(HealthcareService) | |
telecom | Σ | 0..* | ContactPoint |
availableTime | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | 0..* | Extension | |
modifierExtension | Σ ?! | 0..* | Extension |
daysOfWeek | 0..* | codeBinding | |
allDay | 0..1 | boolean | |
availableStartTime | 0..1 | time | |
availableEndTime | 0..1 | time | |
notAvailable | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | 0..* | Extension | |
modifierExtension | Σ ?! | 0..* | Extension |
description | 1..1 | string | |
during | 0..1 | Period | |
availabilityExceptions | 0..1 | string | |
endpoint | 0..* | Reference(Endpoint) |
PractitionerRole | |||
Short | Roles/organizations the practitioner is associated with | ||
Definition | A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time. | ||
Cardinality | 0..* | ||
Constraints |
| ||
Mappings |
| ||
PractitionerRole.id | |||
Short | Logical id of this artifact | ||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||
Cardinality | 0..1 | ||
Type | id | ||
Summary | True | ||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
PractitionerRole.meta | |||
Short | Metadata about the resource | ||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||
Cardinality | 0..1 | ||
Type | Meta | ||
Summary | True | ||
PractitionerRole.implicitRules | |||
Short | A set of rules under which this content was created | ||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. | ||
Cardinality | 0..1 | ||
Type | uri | ||
Modifier | True | ||
Summary | True | ||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||
PractitionerRole.language | |||
Short | Language of the resource content | ||
Definition | The base language in which the resource is written. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | A human language. Binding extensions
| ||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||
PractitionerRole.text | |||
Short | Text summary of the resource, for human interpretation | ||
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||
Cardinality | 0..1 | ||
Type | Narrative | ||
Alias | narrative, html, xhtml, display | ||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: dom-1 | ||
Mappings |
| ||
PractitionerRole.contained | |||
Short | Contained, inline Resources | ||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||
Cardinality | 0..* | ||
Type | Resource | ||
Alias | inline resources, anonymous resources, contained resources | ||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. | ||
Mappings |
| ||
PractitionerRole.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
PractitionerRole.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
PractitionerRole.identifier | |||
Short | Business Identifiers that are specific to a role/location | ||
Definition | Business Identifiers that are specific to a role/location. | ||
Cardinality | 0..* | ||
Type | Identifier | ||
Summary | True | ||
Requirements | Often, specific identities are assigned for the agent. | ||
Mappings |
| ||
PractitionerRole.identifier.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
PractitionerRole.identifier.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
PractitionerRole.identifier.use | |||
Short | usual | official | temp | secondary (If known) | ||
Definition | The purpose of this identifier. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | Identifies the purpose for this identifier, if known . | ||
Modifier | True | ||
Summary | True | ||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
Mappings |
| ||
PractitionerRole.identifier.type | |||
Short | Description of identifier | ||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
Summary | True | ||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||
Mappings |
| ||
PractitionerRole.identifier.system | |||
Short | The namespace for the identifier value | ||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
Cardinality | 0..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||
Examples | Generalhttp://www.acme.com/identifiers/patient | ||
Mappings |
| ||
PractitionerRole.identifier.value | |||
Short | The value that is unique | ||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. | ||
Examples | General123456 | ||
Mappings |
| ||
PractitionerRole.identifier.period | |||
Short | Time period when id is/was valid for use | ||
Definition | Time period during which identifier is/was valid for use. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Summary | True | ||
Mappings |
| ||
PractitionerRole.identifier.assigner | |||
Short | Organization that issued id (may be just text) | ||
Definition | Organization that issued/manages the identifier. | ||
Cardinality | 0..1 | ||
Type | Reference(CareConnect-GPC-Organization-1) | ||
Summary | True | ||
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||
Mappings |
| ||
PractitionerRole.active | |||
Short | Whether this practitioner's record is in active use | ||
Definition | Whether this practitioner's record is in active use. | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Summary | True | ||
Requirements | Need to be able to mark a practitioner record as not to be used because it was created in error. | ||
Comments | Default is true. If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role. | ||
Default value | true | ||
Mappings |
| ||
PractitionerRole.period | |||
Short | The period during which the practitioner is authorized to perform in these role(s) | ||
Definition | The period during which the person is authorized to act as a practitioner in these role(s) for the organization. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Summary | True | ||
Requirements | Even after the agencies is revoked, the fact that it existed must still be recorded. | ||
Mappings |
| ||
PractitionerRole.practitioner | |||
Short | Practitioner that is able to provide the defined services for the organation | ||
Definition | Practitioner that is able to provide the defined services for the organation. | ||
Cardinality | 0..1 | ||
Type | Reference(CareConnect-GPC-Practitioner-1) | ||
Summary | True | ||
Mappings |
| ||
PractitionerRole.organization | |||
Short | Organization where the roles are available | ||
Definition | The organization where the Practitioner performs the roles associated. | ||
Cardinality | 0..1 | ||
Type | Reference(CareConnect-GPC-Organization-1) | ||
Summary | True | ||
Mappings |
| ||
PractitionerRole.code | |||
Short | Roles which this practitioner may perform | ||
Definition | Roles which this practitioner is authorized to perform for the organization. | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | The role a person plays representing an organization | ||
Summary | True | ||
Requirements | Need to know what authority the practitioner has - what can they do? | ||
Comments | A person may have more than one role. At least one role is required. | ||
Slicing | Unordered, Open At End, by coding.system(Value) | ||
Mappings |
| ||
PractitionerRole.code:sdsJobRoleName | |||
Short | Roles which this practitioner may perform | ||
Definition | Roles which this practitioner is authorized to perform for the organization. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | The role a person plays representing an organization | ||
Summary | True | ||
Requirements | Need to know what authority the practitioner has - what can they do? | ||
Comments | A person may have more than one role. At least one role is required. | ||
Mappings |
| ||
PractitionerRole.code:sdsJobRoleName.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
PractitionerRole.code:sdsJobRoleName.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
PractitionerRole.code:sdsJobRoleName.coding | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 1..1 | ||
Type | Coding | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||
Mappings |
| ||
PractitionerRole.code:sdsJobRoleName.coding.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
PractitionerRole.code:sdsJobRoleName.coding.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
PractitionerRole.code:sdsJobRoleName.coding.system | |||
Short | Identity of the terminology system | ||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. | ||
Auto Value | https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1 | ||
Mappings |
| ||
PractitionerRole.code:sdsJobRoleName.coding.version | |||
Short | Version of the system - if relevant | ||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||
Cardinality | 0..0 | ||
Type | string | ||
Summary | True | ||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||
Mappings |
| ||
PractitionerRole.code:sdsJobRoleName.coding.code | |||
Short | Symbol in syntax defined by the system | ||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||
Cardinality | 1..1 | ||
Type | code | ||
Summary | True | ||
Requirements | Need to refer to a particular code in the system. | ||
Mappings |
| ||
PractitionerRole.code:sdsJobRoleName.coding.display | |||
Short | Representation defined by the system | ||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
Mappings |
| ||
PractitionerRole.code:sdsJobRoleName.coding.userSelected | |||
Short | If this coding was chosen directly by the user | ||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||
Cardinality | 0..0 | ||
Type | boolean | ||
Summary | True | ||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||
Mappings |
| ||
PractitionerRole.code:sdsJobRoleName.text | |||
Short | Plain text representation of the concept | ||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||
Comments | Very often the text is the same as a displayName of one of the codings. | ||
Mappings |
| ||
PractitionerRole.specialty | |||
Short | Specific specialty of the practitioner | ||
Definition | Specific specialty of the practitioner. | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | Specific specialty associated with the agency | ||
Summary | True | ||
Mappings |
| ||
PractitionerRole.location | |||
Short | The location(s) at which this practitioner provides care | ||
Definition | The location(s) at which this practitioner provides care. | ||
Cardinality | 0..* | ||
Type | Reference(CareConnect-GPC-Location-1) | ||
Summary | True | ||
Mappings |
| ||
PractitionerRole.healthcareService | |||
Short | The list of healthcare services that this worker provides for this role's Organization/Location(s) | ||
Definition | The list of healthcare services that this worker provides for this role's Organization/Location(s). | ||
Cardinality | 0..* | ||
Type | Reference(HealthcareService) | ||
Mappings |
| ||
PractitionerRole.telecom | |||
Short | Contact details that are specific to the role/location/service | ||
Definition | Contact details that are specific to the role/location/service. | ||
Cardinality | 0..* | ||
Type | ContactPoint | ||
Summary | True | ||
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. | ||
Mappings |
| ||
PractitionerRole.availableTime | |||
Short | Times the Service Site is available | ||
Definition | A collection of times that the Service Site is available. | ||
Cardinality | 0..* | ||
Type | BackboneElement | ||
Comments | More detailed availability information may be provided in associated Schedule/Slot resources. | ||
Constraints |
| ||
Mappings |
| ||
PractitionerRole.availableTime.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
PractitionerRole.availableTime.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
PractitionerRole.availableTime.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | extensions, user content, modifiers | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
PractitionerRole.availableTime.daysOfWeek | |||
Short | mon | tue | wed | thu | fri | sat | sun | ||
Definition | Indicates which days of the week are available between the start and end Times. | ||
Cardinality | 0..* | ||
Type | code | ||
Binding | The days of the week. | ||
Mappings |
| ||
PractitionerRole.availableTime.allDay | |||
Short | Always available? e.g. 24 hour service | ||
Definition | Is this always available? (hence times are irrelevant) e.g. 24 hour service. | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Mappings |
| ||
PractitionerRole.availableTime.availableStartTime | |||
Short | Opening time of day (ignored if allDay = true) | ||
Definition | The opening time of day. Note: If the AllDay flag is set, then this time is ignored. | ||
Cardinality | 0..1 | ||
Type | time | ||
Comments | The timezone is expected to be for where this HealthcareService is provided at. | ||
Mappings |
| ||
PractitionerRole.availableTime.availableEndTime | |||
Short | Closing time of day (ignored if allDay = true) | ||
Definition | The closing time of day. Note: If the AllDay flag is set, then this time is ignored. | ||
Cardinality | 0..1 | ||
Type | time | ||
Comments | The timezone is expected to be for where this HealthcareService is provided at. | ||
Mappings |
| ||
PractitionerRole.notAvailable | |||
Short | Not available during this time due to provided reason | ||
Definition | The HealthcareService is not available during this period of time due to the provided reason. | ||
Cardinality | 0..* | ||
Type | BackboneElement | ||
Constraints |
| ||
Mappings |
| ||
PractitionerRole.notAvailable.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
PractitionerRole.notAvailable.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
PractitionerRole.notAvailable.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | extensions, user content, modifiers | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Mappings |
| ||
PractitionerRole.notAvailable.description | |||
Short | Reason presented to the user explaining why time not available | ||
Definition | The reason that can be presented to the user as to why this time is not available. | ||
Cardinality | 1..1 | ||
Type | string | ||
Mappings |
| ||
PractitionerRole.notAvailable.during | |||
Short | Service not availablefrom this date | ||
Definition | Service is not available (seasonally or for a public holiday) from this date. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Mappings |
| ||
PractitionerRole.availabilityExceptions | |||
Short | Description of availability exceptions | ||
Definition | A 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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
PractitionerRole.endpoint | |||
Short | Technical endpoints providing access to services operated for the practitioner with this role | ||
Definition | Technical endpoints providing access to services operated for the practitioner with this role. | ||
Cardinality | 0..* | ||
Type | Reference(Endpoint) | ||
Requirements | 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. | ||
Mappings |
|
Data model element usage
Element | Use | CareConnect (STU3) | UK Core (R4) |
---|---|---|---|
identifier | |||
active | |||
period | |||
practitioner | |||
organization | |||
code | |||
specialty | |||
location | |||
healthcareService | |||
telecom | |||
availableTime | |||
notAvailable | |||
availabilityExceptions | |||
endpoint |
identifier
Usage
OptionalGuidance
Theidentifier
element MUST be populated with a globally unique and persistent identifier (that is, it doesn’t change between requests and therefore stored with the source data). This MUST be scoped by a provider specific namespace for the identifier.Where consuming systems are integrating data from this resource to their local system, they MUST also persist this identifier at the same time.Example
<identifier> <system value="https://foo.bar/id/list" /> <value value="3d68a68bf-dc19-4e43-af95-cc84ba151583" /> </identifier>
active
Usage
OptionalGuidance
Whether this practitioner's record is in active useExample
<active value="Y"/>
period
Usage
OptionalGuidance
The period during which the practitioner is authorized to perform in these role(s)Example
<period> <value start = "2022-12-05T00:00:00Z" /> <value end = "2023-12-05T00:00:00Z" /> </period>
practitioner
Usage
OptionalGuidance
Practitioner that is able to provide the defined services for the organationExample
<Practitioner value="Practitioner/1"/>
organization
Usage
OptionalGuidance
A reference to Organization where the roles are available (https://developer.nhs.uk/apis/gpconnect-1-6-0/development_branch_surgeries.html) for more details.Example
<Organization value="organisation-9929alp" />
code
Usage
OptionalGuidance
Example
<code> <sdsJobRoleName> <coding> <system value="http://hl7.org/fhir/practitioner-role" /> <code value="nurse" /> <display value="Nurse" /> </coding> <text value="A practitoner with nursing experience that may be qualified/registered" /> </sdsJobRoleName> </code>
specialty
Usage
OptionalGuidance
Specific specialty of the practitionerExample
<specialty> <coding> <system value="http://hl7.org/fhir/practitioner-specialty" /> <code value="cardio" /> <display value="Cardiologist" /> <snomedCT> <url value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" /> <extension> <valueId value="cardio" /> <descriptionId value="cardio" /> <descriptionDisplay value="Cardiologist" /> </extesion> </snomedCT> </coding> <text value="Cardiologist" /> </specialty>
location
Usage
OptionalGuidance
The location(s) at which this practitioner provides care Reference(Location)Example
<location> <reference value="location-99sss999"/> </location>
healthcareService
Usage
OptionalGuidance
The list of healthcare services that this worker provides for this role's Organization/Location(s) Reference(healthcareService)Example
<healthcareService> <reference value="healthcareservice-99sss999"/> </healthcareService>
telecom
Usage
OptionalGuidance
Contact details of the location.Example
<telecom> <system value="phone"/> <value value="(+44) 0123456789"/> <use value="w"/> </telecom>
availableTime
Usage
OptionalGuidance
A collection of times that the Service Site is available.Example
<availableTime> <daysOfWeek value="Mon,Tue,Wed,Fri"/> <allDay value="False" /> <availableStartTime value="09:00:00"/> <availableEndTime value="18:00:00"/> </availableTime>
notAvailable
Usage
OptionalGuidance
Not available during this time due to provided reasonExample
<description value="Christmas Holidays"> <during> <value start = "2024-12-25T00:00:00Z" /> <value end = "2024-12-27T00:00:00Z" /> </during>
availabilityExceptions
Usage
OptionalGuidance
Description of availability exceptions.Example
<availabilityExceptions value="Public Holidays" />
endpoint
Usage
OptionalGuidance
This element SHOULD NOT be populated for GP Connect.Example
<endpoint> <reference value="Endpoint/example"/> </endpoint>