This page is part of the HSPC FHIR Implementation Guide (v0.1.0: Daft For Comment Draft) based on FHIR v1.9.0. This is the current published version. For a full list of available versions, see the Directory of published versions
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Practitioner | 0..* | A person with a formal responsibility in the provisioning of healthcare or related services | ||
id | ∑ | 0..1 | id | Logical id of this artifact |
meta | ∑ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | ∑ | 0..* | Identifier | A identifier for the person as this agent |
active | ∑ | 0..1 | boolean | Whether this practitioner's record is in active use |
name | ∑ | 0..* | HumanName | The name(s) associated with the practitioner |
telecom | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
Extension | I | 0..* | base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta | Extension URL: http://hl7.org/fhir/StructureDefinition/Extension ext-1: Must have either extensions or value[x], not both |
system | ∑ I | 0..1 | code | phone | fax | email | pager | other Binding: ContactPointSystem (required) |
value | ∑ | 0..1 | string | The actual contact point details |
use | ?! ∑ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
rank | ∑ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
period | ∑ | 0..1 | Period | Time period when the contact point was/is in use |
address | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
Extension | I | 0..* | base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta | Extension URL: http://hl7.org/fhir/StructureDefinition/Extension Binding: v2 Yes/no Indicator (preferred) ext-1: Must have either extensions or value[x], not both |
use | ?! ∑ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example: home |
type | ∑ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example: both |
text | ∑ | 0..1 | string | Text representation of the address Example: 137 Nowhere Street, Erewhon 9132 |
line | ∑ | 0..* | string | Street name, number, direction & P.O. Box etc. Example: 137 Nowhere Street |
city | ∑ | 0..1 | string | Name of city, town etc. Example: Erewhon |
district | ∑ | 0..1 | string | District name (aka county) Example: Madison |
state | ∑ | 0..1 | string | Sub-unit of country (abbreviations ok) |
postalCode | ∑ | 0..1 | string | Postal code for area Example: 9132 |
country | ∑ | 0..1 | string | Country (can be ISO 3166 3 letter code) |
period | ∑ | 0..1 | Period | Time period when address was/is in use Example: {"start":"2010-03-23","end":"2010-07-01"} |
gender | ∑ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
birthDate | ∑ | 0..1 | date | The date on which the practitioner was born |
photo | 0..* | Attachment | Image of the person | |
role | BackboneElement | Roles/organizations the practitioner is associated with Slice: Unordered, Open, by Practitioner.role.organization|false|open, Practitioner.role.code | ||
role | 0..* | BackboneElement | Roles/organizations the practitioner is associated with | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! ∑ | 0..* | Extension | Extensions that cannot be ignored |
organization | 0..1 | Reference(Organization) | Organization where the roles are performed | |
code | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: HSPC ProviderPractitioner Type (preferred) | |
specialty | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: HSPC ProviderPractitioner Specialty (preferred) | |
identifier | ∑ | 0..* | Identifier | Business Identifiers that are specific to a role/location |
telecom | ∑ | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
period | ∑ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
location | 0..* | Reference(Location) | The location(s) at which this practitioner provides care | |
healthcareService | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the PractitonerRole | |
role | 0..* | BackboneElement | Roles/organizations the practitioner is associated with | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! ∑ | 0..* | Extension | Extensions that cannot be ignored |
organization | 0..1 | Reference(Organization) | Organization where the roles are performed | |
code | ∑ | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example) |
specialty | ∑ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PractitionerSpecialty (example) |
identifier | ∑ | 0..* | Identifier | Business Identifiers that are specific to a role/location |
telecom | ∑ | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
period | ∑ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
location | 0..* | Reference(Location) | The location(s) at which this practitioner provides care | |
healthcareService | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the PractitonerRole | |
role | 0..* | BackboneElement | Roles/organizations the practitioner is associated with | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
Extension | I | 0..* | base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta | Extension URL: http://hl7.org/fhir/StructureDefinition/Extension Binding: HSPC Practice Affiliation Type (example) ext-1: Must have either extensions or value[x], not both |
Extension | I | 0..* | base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta | Extension URL: http://hl7.org/fhir/StructureDefinition/Extension Binding: HSPC ProviderPractitioner Privilege (preferred) ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?! ∑ | 0..* | Extension | Extensions that cannot be ignored |
organization | 0..1 | Reference(Organization) | Organization where the roles are performed | |
code | ∑ | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example) |
specialty | ∑ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PractitionerSpecialty (example) |
identifier | ∑ | 0..* | Identifier | Business Identifiers that are specific to a role/location |
telecom | ∑ | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
period | ∑ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
location | 0..* | Reference(Location) | The location(s) at which this practitioner provides care | |
healthcareService | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the PractitonerRole | |
qualification | 0..* | BackboneElement | Qualifications obtained by training and certification | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
Extension | I | 0..* | base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta | Extension URL: http://hl7.org/fhir/StructureDefinition/Extension Binding: v2 Yes/no Indicator (preferred) ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?! ∑ | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..* | Identifier | An identifier for this qualification for the practitioner | |
code | 1..1 | CodeableConcept | Coded representation of the qualification Binding: ANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2 (example) | |
period | 0..1 | Period | Period during which the qualification is valid | |
issuer | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |
communication | 0..* | CodeableConcept | A language the practitioner is able to use in patient communication Binding: Common Languages (extensible) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
Extension | I | 0..* | base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, Meta | Extension URL: http://hl7.org/fhir/StructureDefinition/Extension Binding: HSPC Communication Mode (preferred) ext-1: Must have either extensions or value[x], not both |
coding | ∑ | 0..* | Coding | Code defined by a terminology system |
text | ∑ | 0..1 | string | Plain text representation of the concept |
Documentation for this format |
Practitioner(HSPCProviderPractitioner) | |
Definition | A person who is directly or indirectly involved in the provisioning of healthcare. |
Control | 0..* |
Comments | Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual? |
Practitioner.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
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. |
Practitioner.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
Practitioner.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Control | 0..1 |
Type | uri |
Is Modifier | 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 as much as possible. |
Practitioner.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable |
Type | code |
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). |
Practitioner.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Alternate Names | 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. |
Practitioner.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Control | 0..* |
Type | Resource |
Alternate Names | 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. |
Practitioner.extension | |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | 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. |
Practitioner.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | 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. |
Practitioner.identifier | |
Definition | An identifier that applies to this person in this role. |
Control | 0..* |
Type | Identifier |
Requirements | Often, specific identities are assigned for the agent. |
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 | The name(s) associated with the practitioner. |
Control | 0..* |
Type | HumanName |
Requirements | The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. |
Comments | The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general select the value to be used in the ResourceReference.display based on this: 1. There is more than 1 name 2. Use = usual 3. Period is current to the date of the usage 4. Use = official 5. Other order as decided by internal business rules. |
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 independent to any roles the practitioner may have. |
Comments | Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification These typically will have home numbers, or mobile numbers that are not role specific. |
Practitioner.telecom.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Practitioner.telecom.extension (http://hl7.org/fhir/StructureDefinition/Extension) | |
Definition | Optional Extensions Element - found in all resources. |
Control | 0..* |
Type | (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta) |
Invariants | Defined on this element ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])) |
Practitioner.telecom.system | |
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. |
Control | 0..1 This element is affected by the following invariants: cpt-2 |
Binding | Telecommunications form for contact point The codes SHALL be taken from ContactPointSystem |
Type | code |
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 text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. |
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 ContactPointUse |
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. |
Practitioner.telecom.rank | |
Definition | Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values. |
Control | 0..1 |
Type | positiveInt |
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance. |
Practitioner.telecom.period | |
Definition | Time period when the contact point was/is in use. |
Control | 0..1 |
Type | Period |
Practitioner.address | |
Definition | Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. |
Control | 0..* |
Type | Address |
Requirements | The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. |
Comments | The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address). |
Practitioner.address.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Practitioner.address.extension (http://hl7.org/fhir/StructureDefinition/Extension) | |
Definition | Optional Extensions Element - found in all resources. |
Control | 0..* |
Type | (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta) |
Invariants | Defined on this element ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])) |
Practitioner.address.use | |
Definition | The purpose of this address. |
Control | 0..1 |
Binding | The use of an address The codes SHALL be taken from AddressUse |
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 | home |
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 AddressType |
Type | code |
Example | both |
Practitioner.address.text | |
Definition | A full text representation of the address. |
Control | 0..1 |
Type | string |
Requirements | A renderable, unencoded form. |
Comments | Can provide both a text representation and parts. |
Example | 137 Nowhere Street, Erewhon 9132 |
Practitioner.address.line | |
Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. |
Control | 0..* |
Type | string |
Requirements | home | work | temp | old - purpose of this address. |
Example | 137 Nowhere Street |
Practitioner.address.city | |
Definition | The name of the city, town, village or other community or delivery center. |
Control | 0..1 |
Type | string |
Alternate Names | Municpality |
Example | Erewhon |
Practitioner.address.district | |
Definition | The name of the administrative area (county). |
Control | 0..1 |
Type | string |
Alternate Names | County |
Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. |
Example | Madison |
Practitioner.address.state | |
Definition | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). |
Control | 0..1 |
Type | string |
Alternate Names | Province, Territory |
Practitioner.address.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Control | 0..1 |
Type | string |
Alternate Names | Zip |
Example | 9132 |
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. |
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. |
Example | <valuePeriod xmlns="http://hl7.org/fhir"><br/> <start value="2010-03-23"/><br/> <end value="2010-07-01"/><br/></valuePeriod><br/> |
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 AdministrativeGender |
Type | code |
Requirements | Needed to address the person correctly. |
Practitioner.birthDate | |
Definition | The date of birth for the practitioner. |
Control | 0..1 |
Type | date |
Requirements | Needed for identification. |
Practitioner.photo | |
Definition | Image of the person. |
Control | 0..* |
Type | Attachment |
Requirements | Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. |
Practitioner.role | |
Definition | The list of roles/organizations that the practitioner is associated with. |
Control | 0..* |
Type | BackboneElement |
Comments | The address to be used for this PractitionerRole is in the referenced location (removing duplication across all the services provided at the location). |
Practitioner.role(PractitionerRole) | |
Definition | The list of roles/organizations that the practitioner is associated with. |
Control | 0..* |
Type | BackboneElement |
Comments | The address to be used for this PractitionerRole is in the referenced location (removing duplication across all the services provided at the location). |
Practitioner.role.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Practitioner.role.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | 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. |
Practitioner.role.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 |
Alternate Names | 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.role.organization | |
Definition | The organization where the Practitioner performs the roles associated. |
Control | 0..1 |
Type | Reference(Organization) |
Practitioner.role.code | |
Definition | Roles which this practitioner is authorized to perform for the organization. |
Control | 0..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.role.specialty | |
Definition | Specific specialty of the practitioner. |
Control | 0..* |
Type | CodeableConcept |
Practitioner.role.identifier | |
Definition | Business Identifiers that are specific to a role/location. |
Control | 0..* |
Type | Identifier |
Requirements | Some business identifiers are specific to a location and should be able to be associated. |
Practitioner.role.telecom | |
Definition | Contact details that are specific to the role/location/service. |
Control | 0..* |
Type | ContactPoint |
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. |
Practitioner.role.period | |
Definition | The period during which the person is authorized to act as a practitioner in these role(s) for the organization. |
Control | 0..1 |
Type | Period |
Requirements | Even after the agencies is revoked, the fact that it existed must still be recorded. |
Practitioner.role.location | |
Definition | The location(s) at which this practitioner provides care. |
Control | 0..* |
Type | Reference(Location) |
Practitioner.role.healthcareService | |
Definition | The list of healthcare services that this worker provides for this role's Organization/Location(s). |
Control | 0..* |
Type | Reference(HealthcareService) |
Practitioner.role.endpoint | |
Definition | Technical endpoints providing access to services operated for the PractitonerRole. |
Control | 0..* |
Type | Reference(Endpoint) |
Practitioner.role(AdministrativeAffiliation) | |
Definition | The list of roles/organizations that the practitioner is associated with. |
Control | 0..* |
Type | BackboneElement |
Alternate Names | AdministrativeAffiliation |
Comments | The address to be used for this PractitionerRole is in the referenced location (removing duplication across all the services provided at the location). |
Practitioner.role.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Practitioner.role.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | 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. |
Practitioner.role.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 |
Alternate Names | 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.role.organization | |
Definition | The organization where the Practitioner performs the roles associated. |
Control | 0..1 |
Type | Reference(Organization) |
Practitioner.role.code | |
Definition | Roles which this practitioner is authorized to perform for the organization. |
Control | 0..1 |
Binding | The role a person plays representing an organization For example codes, see PractitionerRole |
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.role.specialty | |
Definition | Specific specialty of the practitioner. |
Control | 0..* |
Binding | Specific specialty associated with the agency For example codes, see PractitionerSpecialty |
Type | CodeableConcept |
Practitioner.role.identifier | |
Definition | Business Identifiers that are specific to a role/location. |
Control | 0..* |
Type | Identifier |
Requirements | Some business identifiers are specific to a location and should be able to be associated. |
Practitioner.role.telecom | |
Definition | Contact details that are specific to the role/location/service. |
Control | 0..* |
Type | ContactPoint |
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. |
Practitioner.role.period | |
Definition | The period during which the person is authorized to act as a practitioner in these role(s) for the organization. |
Control | 0..1 |
Type | Period |
Requirements | Even after the agencies is revoked, the fact that it existed must still be recorded. |
Practitioner.role.location | |
Definition | The location(s) at which this practitioner provides care. |
Control | 0..* |
Type | Reference(Location) |
Practitioner.role.healthcareService | |
Definition | The list of healthcare services that this worker provides for this role's Organization/Location(s). |
Control | 0..* |
Type | Reference(HealthcareService) |
Practitioner.role.endpoint | |
Definition | Technical endpoints providing access to services operated for the PractitonerRole. |
Control | 0..* |
Type | Reference(Endpoint) |
Practitioner.role(PracticeAffiliation) | |
Definition | The list of roles/organizations that the practitioner is associated with. |
Control | 0..* |
Type | BackboneElement |
Alternate Names | PracticeAffiliation |
Comments | The address to be used for this PractitionerRole is in the referenced location (removing duplication across all the services provided at the location). |
Practitioner.role.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Practitioner.role.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Practitioner.role.extension (http://hl7.org/fhir/StructureDefinition/Extension) | |
Definition | Optional Extensions Element - found in all resources. |
Control | 0..* |
Type | (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta) |
Invariants | Defined on this element ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])) |
Practitioner.role.extension (http://hl7.org/fhir/StructureDefinition/Extension) | |
Definition | Optional Extensions Element - found in all resources. |
Control | 0..* |
Type | (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta) |
Invariants | Defined on this element ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])) |
Practitioner.role.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 |
Alternate Names | 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.role.organization | |
Definition | The organization where the Practitioner performs the roles associated. |
Control | 0..1 |
Type | Reference(Organization) |
Practitioner.role.code | |
Definition | Roles which this practitioner is authorized to perform for the organization. |
Control | 0..1 |
Binding | The role a person plays representing an organization For example codes, see PractitionerRole |
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.role.specialty | |
Definition | Specific specialty of the practitioner. |
Control | 0..* |
Binding | Specific specialty associated with the agency For example codes, see PractitionerSpecialty |
Type | CodeableConcept |
Practitioner.role.identifier | |
Definition | Business Identifiers that are specific to a role/location. |
Control | 0..* |
Type | Identifier |
Requirements | Some business identifiers are specific to a location and should be able to be associated. |
Practitioner.role.telecom | |
Definition | Contact details that are specific to the role/location/service. |
Control | 0..* |
Type | ContactPoint |
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. |
Practitioner.role.period | |
Definition | The period during which the person is authorized to act as a practitioner in these role(s) for the organization. |
Control | 0..1 |
Type | Period |
Requirements | Even after the agencies is revoked, the fact that it existed must still be recorded. |
Practitioner.role.location | |
Definition | The location(s) at which this practitioner provides care. |
Control | 0..* |
Type | Reference(Location) |
Practitioner.role.healthcareService | |
Definition | The list of healthcare services that this worker provides for this role's Organization/Location(s). |
Control | 0..* |
Type | Reference(HealthcareService) |
Practitioner.role.endpoint | |
Definition | Technical endpoints providing access to services operated for the PractitonerRole. |
Control | 0..* |
Type | Reference(Endpoint) |
Practitioner.qualification | |
Definition | Qualifications obtained by training and certification. |
Control | 0..* |
Type | BackboneElement |
Practitioner.qualification.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Practitioner.qualification.extension (http://hl7.org/fhir/StructureDefinition/Extension) | |
Definition | Optional Extensions Element - found in all resources. |
Control | 0..* |
Type | (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta) |
Invariants | Defined on this element ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])) |
Practitioner.qualification.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | 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.qualification.identifier | |
Definition | An identifier that applies to this person's qualification in this role. |
Control | 0..* |
Type | Identifier |
Requirements | Often, specific identities are assigned for the qualification. |
Practitioner.qualification.code | |
Definition | Coded representation of the qualification. |
Control | 1..1 |
Binding | Specific qualification the practitioner has to provide a service For example codes, see ANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2 |
Type | CodeableConcept |
Practitioner.qualification.period | |
Definition | Period during which the qualification is valid. |
Control | 0..1 |
Type | Period |
Requirements | Qualifications are often for a limited period of time, and can be revoked. |
Practitioner.qualification.issuer | |
Definition | Organization that regulates and issues the qualification. |
Control | 0..1 |
Type | Reference(Organization) |
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 Common Languages; other codes may be used where these codes are not suitable |
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.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Practitioner.communication.extension (http://hl7.org/fhir/StructureDefinition/Extension) | |
Definition | Optional Extensions Element - found in all resources. |
Control | 0..* |
Type | (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta) |
Invariants | Defined on this element ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])) |
Practitioner.communication.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
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 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 labelled as UserSelected = true. |
Practitioner.communication.text | |
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. |
Control | 0..1 |
Type | string |
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. |