Specialty Medication Enrollment
2.1.0 - CI Build

Specialty Medication Enrollment, published by HL7 International - Pharmacy. This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/HL7/fhir-specialty-rx/ and changes regularly. See the Directory of published versions

## Resource Profile: SpecialtyRxPractitioner - Detailed Descriptions

Active as of 2020-03-20

Definitions for the specialty-rx-practitioner resource profile.

- Differential Elements Table
- Key Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here.

1. Practitioner
2. Practitioner.name
Control | 0..?
3. Practitioner.name.given
Control | 10..*
Must Support | true
4. Practitioner.telecom
Control | 10..*
Must Support | true
Slicing | This element introduces a set of slices on Practitioner.telecom. The slices are unordered and Open at End, and can be differentiated using the following discriminators: value @ system
5. Practitioner.telecom.system
Control | 1..?
Must Support | true
6. Practitioner.telecom.value
Control | 1..?
Must Support | true
7. Practitioner.telecom:Phone
SliceName | Phone
Control | 1..*
Must Support | true
8. Practitioner.telecom:Phone.system
Control | 1..?
Must Support | true
Fixed Value | phone
9. Practitioner.telecom:Email
SliceName | Email
Control | 0..?
Must Support | true
10. Practitioner.telecom:Email.system
Control | 1..?
Fixed Value | email
11. Practitioner.telecom:Fax
SliceName | Fax
Control | 0..?
Must Support | true
12. Practitioner.telecom:Fax.system
Control | 1..?
Fixed Value | fax
13. Practitioner.address
Control | 10..*
Must Support | true
14. Practitioner.address.line
Control | 1..?
Must Support | true
15. Practitioner.address.city
Control | 1..?
Must Support | true
16. Practitioner.address.state
Control | 1..?
Must Support | true
17. Practitioner.address.postalCode
Control | 1..?
Must Support | true
18. Practitioner.qualification
Must Support | true

Guidance on how to interpret the contents of this table can be found here.

1. Practitioner
Definition | This is basic constraint on provider for use in US Core resources. A person who is directly or indirectly involved in the provisioning of healthcare.
Control | 0..*
Summary | false
Alternate Names | Provider
Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists())
2. 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Control | 0..1
Type | uri
Is 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
4. Practitioner.identifier
Definition | An identifier that applies to this person in this role.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 10..*
Type | Identifier
Must Support | true
Summary | true
Requirements | Often, specific identities are assigned for the agent.
Comments | NPI must be supported as the identifier system in the US, Tax id is allowed, Local id is allowed in addition to an another identifier supplied by a jurisdictional authority such as a practitioner's Drug Enforcement Administration (DEA) number.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on Practitioner.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators: pattern @ $this
5. Practitioner.identifier.use
Definition | The purpose of this identifier.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known .
Type | code
Is 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 | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Practitioner.identifier.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Control | 10..1
Type | uri
Must Support | true
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.
Comments | Identifier.system is always case sensitive.
Example | General:http://www.acme.com/identifiers/patient
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Practitioner.identifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Control | 10..1
Type | string
Must Support | true
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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Example | General:123456
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. Practitioner.identifier:NPI
SliceName | NPI
Definition | An identifier that applies to this person in this role.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1*
Type | Identifier
Must Support | true
Summary | true
Requirements | Often, specific identities are assigned for the agent.
Pattern Value | <valueIdentifier xmlns="http://hl7.org/fhir"> <system value="http://hl7.org/fhir/sid/us-npi"/> </valueIdentifier>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. Practitioner.name
Definition | The name(s) associated with the practitioner.
Control | 10..*
Type | HumanName
Must Support | true
Summary | true
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: There is more than 1 name Use = usual Period is current to the date of the usage Use = official Other order as decided by internal business rules.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
10. Practitioner.name.use
Definition | Identifies the purpose for this name.
Control | 0..1
Binding | The codes SHALL be taken from NameUse The use of a human name.
Type | code
Is Modifier | true
Summary | true
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names.
Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. 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 | 10..1
Type | string
Must Support | true
Summary | true
Alternate Names | surname
Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. Practitioner.name.given
Definition | Given name.
Control | 10..*
Type | string
Must Support | true
Summary | true
Alternate Names | first name, middle name
Comments | If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. Practitioner.telecom
Definition | A contact detail for the practitioner, e.g. a telephone number or an email address.
Control | 10..*
Type | ContactPoint
Must Support | true
Summary | true
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 to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on Practitioner.telecom. The slices are unordered and Open at End, and can be differentiated using the following discriminators: value @ system
14. Practitioner.telecom.system
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact.
Control | 10..1 This element is affected by the following invariants: cpt-2
Binding | The codes SHALL be taken from ContactPointSystem Telecommunications form for contact point.
Type | code
Must Support | true
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. 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 | 10..1
Type | string
Must Support | true
Summary | true
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. Practitioner.telecom.use
Definition | Identifies the purpose for the contact point.
Control | 0..1
Binding | The codes SHALL be taken from ContactPointUse Use of contact point.
Type | code
Is Modifier | true
Summary | true
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. Practitioner.telecom:Phone
SliceName | Phone
Definition | A contact detail for the practitioner, e.g. a telephone number or an email address.
Control | 10..*
Type | ContactPoint
Must Support | true
Summary | true
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 to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. Practitioner.telecom:Phone.system
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact.
Control | 10..1 This element is affected by the following invariants: cpt-2
Binding | The codes SHALL be taken from ContactPointSystem Telecommunications form for contact point.
Type | code
Must Support | true
Summary | true
Fixed Value | phone
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. Practitioner.telecom:Phone.use
Definition | Identifies the purpose for the contact point.
Control | 0..1
Binding | The codes SHALL be taken from ContactPointUse Use of contact point.
Type | code
Is Modifier | true
Summary | true
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. Practitioner.telecom:Email
SliceName | Email
Definition | A contact detail for the practitioner, e.g. a telephone number or an email address.
Control | 0..*
Type | ContactPoint
Must Support | true
Summary | true
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 to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. Practitioner.telecom:Email.system
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact.
Control | 10..1 This element is affected by the following invariants: cpt-2
Binding | The codes SHALL be taken from ContactPointSystem Telecommunications form for contact point.
Type | code
Summary | true
Fixed Value | email
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. Practitioner.telecom:Email.use
Definition | Identifies the purpose for the contact point.
Control | 0..1
Binding | The codes SHALL be taken from ContactPointUse Use of contact point.
Type | code
Is Modifier | true
Summary | true
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. Practitioner.telecom:Fax
SliceName | Fax
Definition | A contact detail for the practitioner, e.g. a telephone number or an email address.
Control | 0..*
Type | ContactPoint
Must Support | true
Summary | true
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 to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. Practitioner.telecom:Fax.system
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact.
Control | 10..1 This element is affected by the following invariants: cpt-2
Binding | The codes SHALL be taken from ContactPointSystem Telecommunications form for contact point.
Type | code
Summary | true
Fixed Value | fax
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. Practitioner.telecom:Fax.use
Definition | Identifies the purpose for the contact point.
Control | 0..1
Binding | The codes SHALL be taken from ContactPointUse Use of contact point.
Type | code
Is Modifier | true
Summary | true
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. 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 | 10..*
Type | Address
Must Support | true
Summary | true
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).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. Practitioner.address.use
Definition | The purpose of this address.
Control | 0..1
Binding | The codes SHALL be taken from AddressUse The use of an address.
Type | code
Is Modifier | true
Summary | true
Requirements | Allows an appropriate address to be chosen from a list of many.
Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old.
Example | General:home
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. 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 | 10..*
Type | string
Must Support | true
Summary | true
Example | General:137 Nowhere Street
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. Practitioner.address.city
Definition | The name of the city, town, suburb, village or other community or delivery center.
Control | 10..1
Type | string
Must Support | true
Summary | true
Alternate Names | Municpality
Example | General:Erewhon
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. 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 (e.g. US 2 letter state codes).
Control | 10..1
Type | string
Must Support | true
Summary | true
Alternate Names | Province, Territory
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. Practitioner.address.postalCode
Definition | A postal code designating a region defined by the postal service.
Control | 10..1
Type | string
Must Support | true
Summary | true
Alternate Names | Zip
Example | General:9132
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. Practitioner.qualification
Definition | The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.
Control | 0..*
Type | BackboneElement
Must Support | true
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
34. Practitioner.qualification.code
Definition | Coded representation of the qualification.
Control | 1..1
Binding | For example codes, see v2 table 0360, Version 2.7 Specific qualification the practitioner has to provide a service.
Type | CodeableConcept
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here.

1. Practitioner
Definition | This is basic constraint on provider for use in US Core resources.
Control | 0..*
Summary | false
Alternate Names | Provider
2. 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
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.
3. Practitioner.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Control | 0..1
Type | Meta
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Control | 0..1
Type | uri
Is 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Practitioner.language
Definition | The base language in which the resource is written.
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages A human language
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Summary | false
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).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Practitioner.text
Definition | A human-readable narrative that contains a summary of the resource and can 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
Type | Narrative
Summary | false
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 information is added later.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. 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
Summary | false
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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
8. Practitioner.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
9. 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. Practitioner.identifier
Definition | An identifier that applies to this person in this role.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..*
Type | Identifier
Must Support | true
Summary | true
Requirements | Often, specific identities are assigned for the agent.
Comments | NPI must be supported as the identifier system in the US, Tax id is allowed, Local id is allowed in addition to an another identifier supplied by a jurisdictional authority such as a practitioner's Drug Enforcement Administration (DEA) number.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on Practitioner.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators: pattern @ $this
11. Practitioner.identifier.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
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
12. Practitioner.identifier.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on Practitioner.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
13. Practitioner.identifier.use
Definition | The purpose of this identifier.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Type | code
Is 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 | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. Practitioner.identifier.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Control | 0..1
Binding | The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
Type | CodeableConcept
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. Practitioner.identifier.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Control | 1..1
Type | uri
Must Support | true
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.
Comments | Identifier.system is always case sensitive.
Example | General:http://www.acme.com/identifiers/patient
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. Practitioner.identifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Control | 1..1
Type | string
Must Support | true
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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Example | General:123456
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. Practitioner.identifier.period
Definition | Time period during which identifier is/was valid for use.
Control | 0..1
Type | Period
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. Practitioner.identifier.assigner
Definition | Organization that issued/manages the identifier.
Control | 0..1
Type | Reference(Organization)
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. Practitioner.identifier:NPI
SliceName | NPI
Definition | An identifier that applies to this person in this role.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Must Support | true
Summary | true
Requirements | Often, specific identities are assigned for the agent.
Pattern Value | <valueIdentifier xmlns="http://hl7.org/fhir"> <system value="http://hl7.org/fhir/sid/us-npi"/> </valueIdentifier>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. Practitioner.active
Definition | Whether this practitioner's record is in active use.
Control | 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 | 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.
Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. Practitioner.name
Definition | The name(s) associated with the practitioner.
Control | 1..*
Type | HumanName
Must Support | true
Summary | true
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: There is more than 1 name Use = usual Period is current to the date of the usage Use = official Other order as decided by internal business rules.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. Practitioner.name.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
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
23. Practitioner.name.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on Practitioner.name.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
24. Practitioner.name.use
Definition | Identifies the purpose for this name.
Control | 0..1
Binding | The codes SHALL be taken from NameUse The use of a human name
Type | code
Is Modifier | true
Summary | true
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names.
Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. Practitioner.name.text
Definition | Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.
Control | 0..1
Type | string
Summary | true
Requirements | A renderable, unencoded form.
Comments | Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. 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 | 1..1
Type | string
Must Support | true
Summary | true
Alternate Names | surname
Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. Practitioner.name.given
Definition | Given name.
Control | 1..*
Type | string
Must Support | true
Summary | true
Alternate Names | first name, middle name
Comments | If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. 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
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. 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
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. Practitioner.name.period
Definition | Indicates the period of time when this name was valid for the named person.
Control | 0..1
Type | Period
Summary | true
Requirements | Allows names to be placed in historical context.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. Practitioner.telecom
Definition | A contact detail for the practitioner, e.g. a telephone number or an email address.
Control | 1..*
Type | ContactPoint
Must Support | true
Summary | true
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 to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on Practitioner.telecom. The slices are unordered and Open at End, and can be differentiated using the following discriminators: value @ system
32. 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
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
33. Practitioner.telecom.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on Practitioner.telecom.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
34. Practitioner.telecom.system
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact.
Control | 1..1 This element is affected by the following invariants: cpt-2
Binding | The codes SHALL be taken from ContactPointSystem Telecommunications form for contact point
Type | code
Must Support | true
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. 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 | 1..1
Type | string
Must Support | true
Summary | true
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. Practitioner.telecom.use
Definition | Identifies the purpose for the contact point.
Control | 0..1
Binding | The codes SHALL be taken from ContactPointUse Use of contact point
Type | code
Is Modifier | true
Summary | true
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. Practitioner.telecom.rank
Definition | Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Control | 0..1
Type | positiveInt
Summary | true
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. Practitioner.telecom.period
Definition | Time period when the contact point was/is in use.
Control | 0..1
Type | Period
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
39. Practitioner.telecom:Phone
SliceName | Phone
Definition | A contact detail for the practitioner, e.g. a telephone number or an email address.
Control | 1..*
Type | ContactPoint
Must Support | true
Summary | true
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 to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. Practitioner.telecom:Phone.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
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
41. Practitioner.telecom:Phone.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on Practitioner.telecom.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
42. Practitioner.telecom:Phone.system
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact.
Control | 1..1 This element is affected by the following invariants: cpt-2
Binding | The codes SHALL be taken from ContactPointSystem Telecommunications form for contact point
Type | code
Must Support | true
Summary | true
Fixed Value | phone
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
43. Practitioner.telecom:Phone.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
Summary | true
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
44. Practitioner.telecom:Phone.use
Definition | Identifies the purpose for the contact point.
Control | 0..1
Binding | The codes SHALL be taken from ContactPointUse Use of contact point
Type | code
Is Modifier | true
Summary | true
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
45. Practitioner.telecom:Phone.rank
Definition | Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Control | 0..1
Type | positiveInt
Summary | true
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
46. Practitioner.telecom:Phone.period
Definition | Time period when the contact point was/is in use.
Control | 0..1
Type | Period
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
47. Practitioner.telecom:Email
SliceName | Email
Definition | A contact detail for the practitioner, e.g. a telephone number or an email address.
Control | 0..*
Type | ContactPoint
Must Support | true
Summary | true
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 to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
48. Practitioner.telecom:Email.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
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
49. Practitioner.telecom:Email.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on Practitioner.telecom.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
50. Practitioner.telecom:Email.system
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact.
Control | 1..1 This element is affected by the following invariants: cpt-2
Binding | The codes SHALL be taken from ContactPointSystem Telecommunications form for contact point
Type | code
Summary | true
Fixed Value | email
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
51. Practitioner.telecom:Email.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
Summary | true
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
52. Practitioner.telecom:Email.use
Definition | Identifies the purpose for the contact point.
Control | 0..1
Binding | The codes SHALL be taken from ContactPointUse Use of contact point
Type | code
Is Modifier | true
Summary | true
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
53. Practitioner.telecom:Email.rank
Definition | Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Control | 0..1
Type | positiveInt
Summary | true
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
54. Practitioner.telecom:Email.period
Definition | Time period when the contact point was/is in use.
Control | 0..1
Type | Period
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
55. Practitioner.telecom:Fax
SliceName | Fax
Definition | A contact detail for the practitioner, e.g. a telephone number or an email address.
Control | 0..*
Type | ContactPoint
Must Support | true
Summary | true
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 to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
56. Practitioner.telecom:Fax.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
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
57. Practitioner.telecom:Fax.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on Practitioner.telecom.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
58. Practitioner.telecom:Fax.system
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact.
Control | 1..1 This element is affected by the following invariants: cpt-2
Binding | The codes SHALL be taken from ContactPointSystem Telecommunications form for contact point
Type | code
Summary | true
Fixed Value | fax
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
59. Practitioner.telecom:Fax.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
Summary | true
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
60. Practitioner.telecom:Fax.use
Definition | Identifies the purpose for the contact point.
Control | 0..1
Binding | The codes SHALL be taken from ContactPointUse Use of contact point
Type | code
Is Modifier | true
Summary | true
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
61. Practitioner.telecom:Fax.rank
Definition | Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Control | 0..1
Type | positiveInt
Summary | true
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
62. Practitioner.telecom:Fax.period
Definition | Time period when the contact point was/is in use.
Control | 0..1
Type | Period
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
63. 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 | 1..*
Type | Address
Must Support | true
Summary | true
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).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
64. 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
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
65. Practitioner.address.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on Practitioner.address.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
66. Practitioner.address.use
Definition | The purpose of this address.
Control | 0..1
Binding | The codes SHALL be taken from AddressUse The use of an address
Type | code
Is Modifier | true
Summary | true
Requirements | Allows an appropriate address to be chosen from a list of many.
Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old.
Example | General:home
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
67. 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 codes SHALL be taken from AddressType The type of an address (physical / postal)
Type | code
Summary | true
Comments | The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).
Example | General:both
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
68. Practitioner.address.text
Definition | Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.
Control | 0..1
Type | string
Summary | true
Requirements | A renderable, unencoded form.
Comments | Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
Example | General:137 Nowhere Street, Erewhon 9132
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
69. 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 | 1..*
Type | string
Must Support | true
Summary | true
Example | General:137 Nowhere Street
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
70. Practitioner.address.city
Definition | The name of the city, town, suburb, village or other community or delivery center.
Control | 1..1
Type | string
Must Support | true
Summary | true
Alternate Names | Municpality
Example | General:Erewhon
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
71. Practitioner.address.district
Definition | The name of the administrative area (county).
Control | 0..1
Type | string
Summary | true
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 | General:Madison
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
72. 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 (e.g. US 2 letter state codes).
Control | 1..1
Type | string
Must Support | true
Summary | true
Alternate Names | Province, Territory
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
73. Practitioner.address.postalCode
Definition | A postal code designating a region defined by the postal service.
Control | 1..1
Type | string
Must Support | true
Summary | true
Alternate Names | Zip
Example | General:9132
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
74. Practitioner.address.country
Definition | Country - a nation as commonly understood or generally accepted.
Control | 0..1
Type | string
Summary | true
Comments | ISO 3166 3 letter codes can be used in place of a human readable country name.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
75. Practitioner.address.period
Definition | Time period when address was/is in use.
Control | 0..1
Type | Period
Summary | true
Requirements | Allows addresses to be placed in historical context.
Example | General:<valuePeriod xmlns="http://hl7.org/fhir"> <start value="2010-03-23"/> <end value="2010-07-01"/> </valuePeriod>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
76. 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 codes SHALL be taken from AdministrativeGender The gender of a person used for administrative purposes
Type | code
Summary | true
Requirements | Needed to address the person correctly.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
77. Practitioner.birthDate
Definition | The date of birth for the practitioner.
Control | 0..1
Type | date
Summary | true
Requirements | Needed for identification.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
78. Practitioner.photo
Definition | Image of the person.
Control | 0..*
Type | Attachment
Summary | false
Requirements | Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
79. Practitioner.qualification
Definition | The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.
Control | 0..*
Type | BackboneElement
Must Support | true
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
80. 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
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
81. Practitioner.qualification.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
82. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
83. Practitioner.qualification.identifier
Definition | An identifier that applies to this person's qualification in this role.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Summary | false
Requirements | Often, specific identities are assigned for the qualification.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
84. Practitioner.qualification.code
Definition | Coded representation of the qualification.
Control | 1..1
Binding | For example codes, see v2 table 0360, Version 2.7 Specific qualification the practitioner has to provide a service
Type | CodeableConcept
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
85. Practitioner.qualification.period
Definition | Period during which the qualification is valid.
Control | 0..1
Type | Period
Summary | false
Requirements | Qualifications are often for a limited period of time, and can be revoked.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
86. Practitioner.qualification.issuer
Definition | Organization that regulates and issues the qualification.
Control | 0..1
Type | Reference(Organization)
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
87. Practitioner.communication
Definition | A language the practitioner can use in patient communication.
Control | 0..*
Binding | The codes SHOULD be taken from CommonLanguages A human language
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | CodeableConcept
Summary | false
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 code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))