GPConnect-Practitioner-1
Practitioner | |
Definition |
A person who is directly or indirectly involved in the provisioning of healthcare. |
Control | 1..1 |
Type | Practitioner |
Comments |
Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual? |
Practitioner.identifier(SDS User ID) | |
Definition |
An identifier that applies to this person in this role. |
Control | 0..1 |
Type | Identifier |
Requirements |
All doctors practising in the UK require a GMC code. |
Comments | |
Practitioner.identifier.system | |
Definition |
Establishes the namespace in which set of possible id values is unique. |
Control | 1..1 |
Type | Uri |
Requirements |
There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers. |
Comments | |
Fixed Value | http://fhir.nhs.net/Id/sds-user-id |
Practitioner.identifier.value | |
Definition |
The portion of the identifier typically displayed to the user and which is unique within the context of the system. |
Control | 1..1 |
Type | String |
Comments |
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. |
Example | 1234567 |
Practitioner.identifier(SDS Role Profile ID) | |
Definition |
Other identifier used to identify the practitioner. |
Control | 0..* |
Type | Identifier |
Requirements |
Often, specific identities are assigned for the agent. |
Comments | |
Practitioner.identifier.system | |
Definition |
Establishes the namespace in which set of possible id values is unique. |
Control | 1..1 |
Type | Uri |
Requirements |
There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers. |
Comments | |
Fixed Value | http://fhir.nhs.net/Id/sds-user-id |
Practitioner.identifier.value | |
Definition |
The portion of the identifier typically displayed to the user and which is unique within the context of the system. |
Control | 1..1 |
Type | String |
Comments |
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. |
Example | 1234567 |
Practitioner.active | |
Definition |
Whether this practitioner's record is in active use. |
Control | 0..1 |
Type | Boolean |
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 |
Practitioner.name | |
Definition |
A name associated with the person/practitioner. |
Control | 1..1 |
Type | HumanName |
Requirements |
Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. |
Comments | |
Practitioner.name.use | |
Definition |
Identifies the purpose for this name. |
Control | 0..1 |
Binding |
The use of a human name The codes SHALL be taken from http://hl7.org/fhir/ValueSet/name-use |
Type | Code |
Is Modifier | True |
Requirements |
Allows the appropriate name for a particular context of use to be selected from among a set of names. |
Comments |
This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old. |
Practitioner.name.family | |
Definition |
The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. |
Control | 0..1 |
Type | String |
Aliases | surname |
Comments |
For family name, hyphenated names such as "Smith-Jones" are a single name, but names with spaces such as "Smith Jones" are broken into multiple parts. |
Example | Wood |
Practitioner.name.given | |
Definition |
Given name. |
Control | 0..* |
Type | String |
Aliases | first name, middle name |
Comments |
If only initials are recorded, they may be used in place of the full name. Not called "first name" since given names do not always come first. |
Example | Tom |
Practitioner.name.prefix | |
Definition |
Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. |
Control | 0..* |
Type | String |
Comments | |
Example | Dr. |
Practitioner.name.suffix | |
Definition |
Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. |
Control | 0..* |
Type | String |
Comments | |
Practitioner.name.period | |
Definition |
Indicates the period of time when this name was valid for the named person. |
Control | 0..1 |
Type | Period |
Requirements |
Allows names to be placed in historical context. |
Comments | |
Practitioner.name.period.start | |
Definition |
The start of the period. The boundary is inclusive. |
Control | 0..1 ? |
Type | DateTime |
Comments |
If the low element is missing, the meaning is that the low boundary is not known. |
Practitioner.name.period.end | |
Definition |
The end of the period. If the end of the period is missing, it means that the period is ongoing. |
Control | 0..1 ? |
Type | DateTime |
Comments |
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. |
Practitioner.telecom | |
Definition |
A contact detail for the practitioner, e.g. a telephone number or an email address. |
Control | 0..* |
Type | ContactPoint |
Requirements |
Need to know how to reach a practitioner. |
Comments |
Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification. |
Practitioner.telecom.system | |
Definition |
Telecommunications form for contact point - what communications system is required to make use of the contact. |
Control | 0..1 ? |
Binding |
Telecommunications form for contact point The codes SHALL be taken from http://hl7.org/fhir/ValueSet/contact-point-system |
Type | Code |
Comments | |
Example | phone |
Practitioner.telecom.value | |
Definition |
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). |
Control | 0..1 |
Type | String |
Requirements |
Need to support legacy numbers that are not in a tightly controlled format. |
Comments |
Additional out of band data such as extensions, or notes about use of the contact are sometimes included in the value. |
Example | 0113-333-1231 |
Practitioner.telecom.use | |
Definition |
Identifies the purpose for the contact point. |
Control | 0..1 |
Binding |
Use of contact point The codes SHALL be taken from http://hl7.org/fhir/ValueSet/contact-point-use |
Type | Code |
Is Modifier | True |
Requirements |
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. |
Comments |
This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. |
Example | work |
Practitioner.telecom.period | |
Definition |
Time period when the contact point was/is in use. |
Control | 0..1 |
Type | Period |
Comments | |
Practitioner.telecom.period.start | |
Definition |
The start of the period. The boundary is inclusive. |
Control | 0..1 ? |
Type | DateTime |
Comments |
If the low element is missing, the meaning is that the low boundary is not known. |
Practitioner.telecom.period.end | |
Definition |
The end of the period. If the end of the period is missing, it means that the period is ongoing. |
Control | 0..1 ? |
Type | DateTime |
Comments |
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. |
Practitioner.address | |
Definition |
The postal address where the practitioner can be found or visited or to which mail can be delivered. |
Control | 0..* |
Type | Address |
Requirements |
Need to keep track where the practitioner can found during work or for directing mail. |
Comments | |
Practitioner.address.use | |
Definition |
The purpose of this address. |
Control | 0..1 |
Binding |
The use of an address The codes SHALL be taken from http://hl7.org/fhir/ValueSet/address-use |
Type | Code |
Is Modifier | True |
Requirements |
Allows an appropriate address to be chosen from a list of many. |
Comments |
This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
Example | work |
Practitioner.address.type | |
Definition |
Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
Control | 0..1 |
Binding |
The type of an address (physical / postal) The codes SHALL be taken from http://hl7.org/fhir/ValueSet/address-type |
Type | Code |
Comments | |
Example | both |
Practitioner.address.line | |
Definition |
This component contains the house number, apartment number, street name, street direction, delivery hints, and similar address information. |
Control | 0..* |
Type | String |
Requirements |
home | work | temp | old - purpose of this address. |
Comments | |
Example | 13, Amber Street |
Practitioner.address.city | |
Definition |
The name of the city, town, village or other community or delivery center. |
Control | 0..1 |
Type | String |
Aliases | Muncipality |
Comments | |
Example | Leeds |
Practitioner.address.district | |
Definition |
The name of the administrative area (county). |
Control | 0..1 |
Type | String |
Aliases | County |
Comments |
District is sometimes known as county, but in some regions 'county' in used in place of city (municipality), so county name should be conveyed in city instead. |
Example | West Yorkshire |
Practitioner.address.postalCode | |
Definition |
A postal code designating a region defined by the postal service. |
Control | 0..1 |
Type | String |
Aliases | Zip |
Comments | |
Example | LS20 1TV |
Practitioner.address.country | |
Definition |
Country - a nation as commonly understood or generally accepted. |
Control | 0..1 |
Type | String |
Comments |
ISO 3166 3 letter codes can be used in place of a full country name. |
Example | GBR |
Practitioner.address.period | |
Definition |
Time period when address was/is in use. |
Control | 0..1 |
Type | Period |
Requirements |
Allows addresses to be placed in historical context. |
Comments | |
Practitioner.address.period.start | |
Definition |
The start of the period. The boundary is inclusive. |
Control | 0..1 ? |
Type | DateTime |
Comments |
If the low element is missing, the meaning is that the low boundary is not known. |
Practitioner.address.period.end | |
Definition |
The end of the period. If the end of the period is missing, it means that the period is ongoing. |
Control | 0..1 ? |
Type | DateTime |
Comments |
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. |
Practitioner.gender | |
Definition |
Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. |
Control | 0..1 |
Binding |
The gender of a person used for administrative purposes The codes SHALL be taken from http://fhir.nhs.net/ValueSet/administrative-gender-1 |
Type | Code |
Requirements |
Needed to address the person correctly and also required so patients can select practitioner of appropriate gender, if desired. |
Comments | |
Example | male |
Practitioner.practitionerRole | |
Definition |
The list of Roles/Organizations that the Practitioner is associated with. |
Control | 0..* |
Type | BackboneElement |
Comments | |
Practitioner.practitionerRole.modifierExtension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | True |
Aliases | 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. |
Practitioner.practitionerRole.managingOrganization | |
Definition |
The Organization where the Practitioner performs the roles associated. |
Control | 0..1 |
Comments | |
Practitioner.practitionerRole.managingOrganization.reference | |
Definition |
A 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. |
Control | 1..1 ? |
Type | String |
Comments |
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. |
Example | Organization/79600119-ebaf-4362-bb89-d473a33b1675 |
Practitioner.practitionerRole.managingOrganization.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | String |
Comments |
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. |
Example | Wood Town GP Practice |
Practitioner.practitionerRole.role | |
Definition |
Roles which this practitioner is authorized to perform for the organization. |
Control | 0..1 |
Binding |
The job role for an employee at an organization The codes SHALL be taken from http://fhir.nhs.net/ValueSet/sds-job-role-name-1 |
Type | CodeableConcept |
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. |
Practitioner.practitionerRole.role.coding | |
Definition |
A code taken from the RBAC list of codes |
Control | 0..1 |
Type | Coding |
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 V3 Core Principles for more information. Ordering of codings is undefined and SHALL not be used to infer meaning. |
Practitioner.practitionerRole.role.coding.system | |
Definition |
The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | Uri |
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. |
Fixed Value | http://fhir.nhs.net/ValueSet/sds-job-role-name-1 |
Practitioner.practitionerRole.role.coding.code | |
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). |
Control | 1..1 |
Type | Code |
Requirements |
Need to refer to a particular code in the system. |
Comments | |
Example | R0050 |
Practitioner.practitionerRole.role.coding.display | |
Definition |
A representation of the meaning of the code in the system, following the rules of the system. |
Control | 1..1 |
Type | String |
Requirements |
Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | |
Example | General Medical Practitioner |
Practitioner.communication | |
Definition |
A language the practitioner is able to use in patient communication. |
Control | 0..* |
Binding |
A human language The codes SHALL be taken from http://fhir.nhs.net/ValueSet/human-language-1 |
Type | CodeableConcept |
Requirements |
Knowing which language a practitioner speaks can help in facilitating communication with patients. |
Comments |
The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. |
Practitioner.communication.coding | |
Definition |
A code taken from the human language list of codes. |
Control | 0..1 |
Type | Coding |
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 V3 Core Principles for more information. Ordering of codings is undefined and SHALL not be used to infer meaning. |
Practitioner.communication.coding.system | |
Definition |
The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | Uri |
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. |
Fixed Value | http://fhir.nhs.net/ValueSet/human-language-1 |
Practitioner.communication.coding.code | |
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). |
Control | 1..1 |
Type | Code |
Requirements |
Need to refer to a particular code in the system. |
Comments | |
Example | en |
Practitioner.communication.coding.display | |
Definition |
A representation of the meaning of the code in the system, following the rules of the system. |
Control | 1..1 |
Type | String |
Requirements |
Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | |
Example | English |