Electronic Long-Term Services and Supports (eLTSS) Release 1 - US Realm
2.0.0 - STU2
Electronic Long-Term Services and Supports (eLTSS) Release 1 - US Realm
2.0.0 - STU2
Electronic Long-Term Services and Supports (eLTSS) Release 1 - US Realm, published by HL7 International / Human and Social Services. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/eLTSS/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/eltss/StructureDefinition/Practitioner-eltss | Version: 2.0.0 | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: Practitioner_eltss | ||
Practitioner for eLTSS
The following aids in finding the location of eLTSS data elements. See R4 FHIR Mapping page for complete guidance, here we are providing a subset of fields for convenience.
| eLTSS Grouping | eLTSS Data Element Name | Data Element Definition (includes examples, expected list of values and usage note where applicable) | FHIR R4 Resource Element(s) | FHIR R4 Resource Element Cardinality (with US Core Constraints) | Additional Mapping Details | Important change |
|---|---|---|---|---|---|---|
| Person Centered Planning | Plan Monitor Name | The name of the person responsible for monitoring the plan. | CarePlan → encounter (Encounter) Encounter → episodeOfCare(EpisodeOfCare) EpisodeOfCare → careManager(Practitioner) Practitioner → name → family Practitioner → name → given Practitioner → name → text |
CarePlan ...encounter(Encounter) 0..1 ...... episodeOfCare(EpisodeOfCare)0..1 .........careManager(Practitioner) 0..1 ............name 0..* ...............family 0-1 ................given 0-* ................text 0-1 |
1) Will use CarePlan → encounter to reference the EpisodeOfCare that defines the plan monitor (care manager) for the plan. 2) EpisodeOfCare → careManager references the Practitioner who is monitoring the plan. 3) given is used for both first name & MI, so need more than one. 4) family is a string with the person's surname. 5) text is a string that contains the full name of the person. 6) The values for Plan Monitor Name and Plan Monitor Printed Name would include the same information. |
|
| Person Centered Planning | Plan Monitor Phone Number | The primary phone number (and extension when applicable) of the plan monitor. | CarePlan → encounter (Encounter) Encounter → episodeOfCare(EpisodeOfCare) EpisodeOfCare → careManager(Practitioner) Practitioner → telecom → system Practitioner → telecom → value |
CarePlan ...encounter(Encounter) 0..1 ...... episodeOfCare(EpisodeOfCare)0..1 .........careManager(Practitioner) 0..1 ............telecom 0..* ...............system 0..1 ................value 0..1 |
1) Will use CarePlan → encounter to reference the EpisodeOfCare that defines the plan monitor (care manager) for the plan. 2) EpisodeOfCare → careManager references the Practitioner who is monitoring the plan. 3) telecom is of type ContactPoint (https://www.hl7.org/fhir/datatypes.html#contactpoint) which contains elements to populate for the phone number. 4) system is required if value is provided, and can be: phone, fax, email, pager, url, sms, other. 5) Per FHIR, phone # should be formatted according to ITU-T E.123, so "(555) 675 5745" or "+22 555 675 5745". |
|
| Service Provider Information | Support Planner Name | The name of the person (e.g., Case Manager, Care Coordinator, Plan Coordinator) who helped develop the plan. | CarePlan → author(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization | CareTeam) Practitioner | Patient | RelatedPerson → name → family Practitioner | Patient | RelatedPerson → name → given Practitioner | Patient | RelatedPerson → name → text Organization | CareTeam → name |
CarePlan ...author(Patient | Practitioner | RelatedPerson ) 0..1 ......name 0..* .........family 0..1 .........given 0..* .........text 0..1 CarePlan …author(Organization | CareTeam ) 0..1 ......name 0..1 |
1) Will use CarePlan → author to reference a Practitioner, PractitionerRole, RelatedPerson, Organization, CareTeam or Patient (in self-directed plans) who is the primary author of the care plan being developed. 2) Practitioner, Organization, CareTeam, RelatedPerson and Patient all include name. 3) PractitionerRole should be used when the Organization for whom the Practitioner works for is also needed. 4) given is used for both first name & MI, so need more than one. 5) family is a string with the person's surname. 6) text is a string that contains the full name of the person. 7) The values for Support Planner Name and Support Planner Printed Name would include the same information. |
|
| Service Provider Information | Support Planner Phone Number | The primary phone number (and extension when applicable) of the support planner. | CarePlan → author(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization | CareTeam ) Patient | Practitioner | PractitionerRole | RelatedPerson | Organization | CareTeam → telecom → system Patient | Practitioner | PractitionerRole | RelatedPerson | Organization | CareTeam → telecom → value |
CarePlan ...author(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization | CareTeam ) 0..1 ......telecom 0..* .........system 0..1 .........value 0..1 |
1) Will use CarePlan → author to reference a Practitioner, PractitionerRole, RelatedPerson, Organization, CareTeam or Patient (in self-directed plan) who is the primary author of the care plan being developed. 2) Practitioner, PractitionerRole, RelatedPerson, Organization, CareTeam and Patient all include telecom. 3) PractitionerRole should be used when the Organization for whom the Practitioner works for is also needed. 4) telecom is of type ContactPoint which contains elements to populate for the phone number. 5) system is required if value is provided, and can be: phone, fax, email, pager, url, sms, other. 6) Per FHIR, phone # should be formatted according to ITU-T E.123, so "(555) 675 5745" or "+22 555 675 5745". |
|
| Service Provider Information | Service Provider Name | The name of the entity or individual providing the service. For paid services use the organization/agency name, for non-paid services use the first and last name of the individual providing the service. |
CarePlan → activity → reference(ServiceRequest) ServiceRequest → performer(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | HealthcareService | CareTeam) Practitioner | PractitionerRole | CareTeam | Organization | Patient | Device | RelatedPerson | HealthcareService → name |
CarePlan ...activity 0..* ......reference(ServiceRequest) 0..1 .........performer(Practitioner | PractitionerRole | Patient | Device | RelatedPerson | HealthcareService | CareTeam) 0..* ............name 0..1 ---------------------------------- .........performer(Organization) 0..* ............name 1 |
1) Will use CarePlan → activity → reference to reference a ServiceRequest, and performer to reference a RelatedPerson, Organization or HealthcareService. Other options listed are available in FHIR, but may not be appropriate here. 2) Per eLTSS Dataset element definition, performer would reference an Organization or HealthcareService for paid services, and RelatedPerson for a non-paid service. 3) Organization → name and HealthcareService → name are strings with the organization's name. 4) RelatedPerson → name is a complex data element that includes strings for the person's surname and first name. 6) name is required by US Core for Organization. 7) The values for Service Provider Name and Service Provider Printed Name would include the same information. |
|
| Service Provider Information | Service Provider Phone Number | The primary phone number (and extension when applicable) of the service provider. | CarePlan → activity → reference(ServiceRequest) ServiceRequest → performer(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | HealthcareService | CareTeam) Practitioner | PractitionerRole | CareTeam | Organization | Patient | Device | RelatedPerson | HealthcareService → telecom → system Practitioner | PractitionerRole | CareTeam | Organization | Patient | Device | RelatedPerson | HealthcareService → telecom → value |
CarePlan ...activity 0..* ......reference(ServiceRequest) 0..1 .........performer(Practitioner | PractitionerRole | Patient | Device | RelatedPerson | HealthcareService | CareTeam) 0..* ............telecom 0..* .............system 0..1 .............value 0..1 ---------------------------------- .........performer(Organization) 0..* ............telecom 1..* .............system 0..1 .............value 1 |
1) Will use CarePlan → activity → reference to reference a ServiceRequest, and performer to reference a RelatedPerson, Organization or HealthcareService. Other options listed are available in FHIR, but may not be appropriate here. 2) Per eLTSS Dataset element definition, performer would reference an Organization or HealthcareService for paid services, and RelatedPerson for a non-paid service. 3) telecom is of type ContactPoint (https://www.hl7.org/fhir/datatypes.html#contactpoint) which contains elements to populate for the phone number. 4) system is required if value is provided, and can be: phone, fax, email, pager, url, sms, other. 5) Per FHIR, phone # should be formatted according to ITU-T E.123, so "(555) 675 5745" or "+22 555 675 5745". 6) US Core requires at least one contact be provided in telecom for an Organization. |
| Data Requirements Not Specific to eLTSS Dataset Data Elements This section documents data elements that are mandatory per FHIR XML schemas or US Core requirements, but that do not align with individual eLTSS Dataset data elements. |
||||
|---|---|---|---|---|
| FHIR Data Element Name Requirement Source |
Data Element Definition | FHIR R4 Resource Element(s) | FHIR R4 Resource Element Cardinality (with US Core Constraints) | Additional Mapping Details |
| Practitioner Identifier US Core |
An identifier that applies to this person in this role. | Practitioner → identifier | Practitioner ...identifier 1..* |
1) At least one identifier is required by US Core. NPI is preferred. Tax id is allowed. Local id is allowed in addition to 'authoritative' identifier. |
| Practitioner Name US Core |
The name(s) associated with the practitioner. | Practitioner → name | Practitioner ...name 1 |
1) US Core requires one name for a Practitioner. |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCorePractitionerProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Practitioner |
0..* | USCorePractitionerProfile | A person with a formal responsibility in the provisioning of healthcare or related services | |
  address |
0..* | Address | Address(es) of the practitioner | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner |
0..* | USCorePractitionerProfile | A person with a formal responsibility in the provisioning of healthcare or related services | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
  Slices for identifier |
SΣ | 1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by pattern:$this |
  identifier:All Slices |
Content/Rules for all slices | |||
  use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
 value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
  identifier:NPI |
SΣC | 0..* | Identifier | An identifier for the person as this agent us-core-16: NPI must be 10 digits us-core-17: NPI check digit must be valid (Luhn algorithm check) Required Pattern: At least the following |
   system |
1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
 name |
SΣ | 1..* | HumanName | The name(s) associated with the practitioner |
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
| family |
SΣ | 1..1 | string | Family name (often called 'Surname') |
| telecom |
SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) |
| system |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value |
SΣ | 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): Use of contact point. |
 address |
SΣ | 0..* | Address | Address(es) of the practitioner |
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| line |
SΣ | 0..4 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
| city |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
| state |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. |
| postalCode |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 |
| country |
SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Practitioner.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Practitioner.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | |
| Practitioner.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| Practitioner.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | |
| Practitioner.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | |
| Practitioner.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Practitioner | 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 | error | Practitioner | 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 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| us-core-16 | error | Practitioner.identifier:NPI | NPI must be 10 digits : value.matches('^[0-9]{10}$') | |
| us-core-17 | error | Practitioner.identifier:NPI | NPI check digit must be valid (Luhn algorithm check) : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0) |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner |
0..* | USCorePractitionerProfile | 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: CommonLanguages (preferred): A human language.
| |||||
| text |
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 | ||||
| Slices for identifier |
SΣ | 1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by pattern:$this | ||||
| identifier:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
 assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:NPI |
SΣC | 0..* | Identifier | An identifier for the person as this agent us-core-16: NPI must be 10 digits us-core-17: NPI check digit must be valid (Luhn algorithm check) Required Pattern: At least the following | ||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
| type |
0..1 | CodeableConcept | Description of identifier | |||||
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |||||
| value |
0..1 | string | The value that is unique | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| active |
Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
| name |
SΣ | 1..* | HumanName | The name(s) associated with the practitioner | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
| text |
Σ | 0..1 | string | Text representation of the full name | ||||
| family |
SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
| given |
Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
| telecom |
SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value |
SΣ | 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): Use of contact point. | ||||
| 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 |
SΣ | 0..* | Address | Address(es) of the practitioner | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
| type |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line |
SΣ | 0..4 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
| city |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
| district |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. | ||||
| postalCode |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 | ||||
| country |
SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| period |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| gender |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate |
Σ | 0..1 | date | The date on which the practitioner was born | ||||
| photo |
0..* | Attachment | Image of the person | |||||
| qualification |
0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
0..* | Identifier | An identifier for this qualification for the practitioner | |||||
| code |
1..1 | CodeableConcept | Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service. | |||||
| 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 can use in patient communication Binding: CommonLanguages (preferred): A human language.
| |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Practitioner.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Practitioner.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Practitioner.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Practitioner.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | ||||
| Practitioner.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| Practitioner.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| Practitioner.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | ||||
| Practitioner.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1from the FHIR Standard | ||||
| Practitioner.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state | ||||
| Practitioner.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Practitioner.qualification.code | example | v2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)http://terminology.hl7.org/ValueSet/v2-2.7-0360from the FHIR Standard | ||||
| Practitioner.communication | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Practitioner | 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 | error | Practitioner | 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 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| us-core-16 | error | Practitioner.identifier:NPI | NPI must be 10 digits : value.matches('^[0-9]{10}$') | |
| us-core-17 | error | Practitioner.identifier:NPI | NPI check digit must be valid (Luhn algorithm check) : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0) |
This structure is derived from USCorePractitionerProfile
Differential View
This structure is derived from USCorePractitionerProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner |
0..* | USCorePractitionerProfile | A person with a formal responsibility in the provisioning of healthcare or related services | |
| address |
0..* | Address | Address(es) of the practitioner | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner |
0..* | USCorePractitionerProfile | A person with a formal responsibility in the provisioning of healthcare or related services | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
SΣ | 1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by pattern:$this |
| identifier:All Slices |
Content/Rules for all slices | |||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:NPI |
SΣC | 0..* | Identifier | An identifier for the person as this agent us-core-16: NPI must be 10 digits us-core-17: NPI check digit must be valid (Luhn algorithm check) Required Pattern: At least the following |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
| name |
SΣ | 1..* | HumanName | The name(s) associated with the practitioner |
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
| family |
SΣ | 1..1 | string | Family name (often called 'Surname') |
| telecom |
SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) |
| system |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value |
SΣ | 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): Use of contact point. |
| address |
SΣ | 0..* | Address | Address(es) of the practitioner |
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| line |
SΣ | 0..4 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
| city |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
| state |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. |
| postalCode |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 |
| country |
SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Practitioner.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Practitioner.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | |
| Practitioner.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| Practitioner.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | |
| Practitioner.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | |
| Practitioner.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Practitioner | 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 | error | Practitioner | 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 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| us-core-16 | error | Practitioner.identifier:NPI | NPI must be 10 digits : value.matches('^[0-9]{10}$') | |
| us-core-17 | error | Practitioner.identifier:NPI | NPI check digit must be valid (Luhn algorithm check) : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner |
0..* | USCorePractitionerProfile | 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: CommonLanguages (preferred): A human language.
| |||||
| text |
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 | ||||
| Slices for identifier |
SΣ | 1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by pattern:$this | ||||
| identifier:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:NPI |
SΣC | 0..* | Identifier | An identifier for the person as this agent us-core-16: NPI must be 10 digits us-core-17: NPI check digit must be valid (Luhn algorithm check) Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
| type |
0..1 | CodeableConcept | Description of identifier | |||||
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |||||
| value |
0..1 | string | The value that is unique | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| active |
Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
| name |
SΣ | 1..* | HumanName | The name(s) associated with the practitioner | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
| text |
Σ | 0..1 | string | Text representation of the full name | ||||
| family |
SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
| given |
Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
| telecom |
SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value |
SΣ | 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): Use of contact point. | ||||
| 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 |
SΣ | 0..* | Address | Address(es) of the practitioner | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
| type |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line |
SΣ | 0..4 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
| city |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
| district |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. | ||||
| postalCode |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 | ||||
| country |
SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| period |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| gender |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate |
Σ | 0..1 | date | The date on which the practitioner was born | ||||
| photo |
0..* | Attachment | Image of the person | |||||
| qualification |
0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
0..* | Identifier | An identifier for this qualification for the practitioner | |||||
| code |
1..1 | CodeableConcept | Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service. | |||||
| 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 can use in patient communication Binding: CommonLanguages (preferred): A human language.
| |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Practitioner.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Practitioner.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Practitioner.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Practitioner.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | ||||
| Practitioner.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| Practitioner.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| Practitioner.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | ||||
| Practitioner.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1from the FHIR Standard | ||||
| Practitioner.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state | ||||
| Practitioner.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Practitioner.qualification.code | example | v2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)http://terminology.hl7.org/ValueSet/v2-2.7-0360from the FHIR Standard | ||||
| Practitioner.communication | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Practitioner | 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 | error | Practitioner | 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 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| us-core-16 | error | Practitioner.identifier:NPI | NPI must be 10 digits : value.matches('^[0-9]{10}$') | |
| us-core-17 | error | Practitioner.identifier:NPI | NPI check digit must be valid (Luhn algorithm check) : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0) |
This structure is derived from USCorePractitionerProfile
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Human and Social Services. Package hl7.fhir.us.eltss#2.0.0 based on FHIR 4.0.1. Generated 2024-04-26
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change