| Provider UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
A person or organization which is authorized to perform healthcare-related services.
Attributes | ||
«AD» Address | address |
The physical location at which the Healthcare Provider is located or to which mail can be directed."The postal address where the practitioner can be found or visited or to which mail can be delivered." - HL7 FHIR, Practitioner.address. |
LicensedProvider | asLlicensedProvider |
Pointer to information about the Provider applicable to their Role of a Licensed Provider. |
MedicaidProvider | asMedicaidProvider |
Pointer to information about the Provider applicable to their Role of a Medicaid Provider. |
MedicareProvider | asMedicareProvider |
Pointer to information about the Provider applicable to their Role of a Medicare Provider. |
String | digitalCertificateDistinguishedName |
"Distinguished Name field from digital certificate" - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012. |
String | digitalCertificateId |
"Serial number from the public digital certificate" - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012. |
«II» Id | identifier |
Uniquely identifies the practitioner. This property should not contain the Tax Id or the National Provider Id, as these types of identifiers are modeled separately."An identifier that applies to this person in this role." - HL7 FHIR, Practitioner.identifier."The actual identification for the prescriber, pharmacist, et cetera, which is qualified by the Reference Qualifier." - NCPDP Script (Field 1154)"Defines the Reference number, field 1154. X-12 DE 128. One occurrence is the prescriber number. One occurrence may be used to identify the clinic. One occurrence may be used to identify a supervisor. If the prescriber has an NPI, one occurrence must contain the value HPI (NPI). If the prescriber has a DEA number, one occurrence must contain the value DH (DEA Number). Not every entity allowed to prescribe may have an NPI or DEA. If this is the case, the other identifiers can be used." - NCPDP Script (Field 1153). Possible values include: Certificate to Prescribe (CTP) number (the CTP is an additional number to the state license number that a board of pharmacy assigns to prescribing individuals after completion of specific requirements); DEA number; Dentist License Number; Medicaid Number; Medicare Number; NCPDP Provider ID Number; NPI - National Provider ID; Social Security Number; State License Number; etc. |
Boolean | isActive |
"Whether this practitioner's record is in active use." - HL7 FHIR, Practitioner.active. |
«II» Id | nationalProviderId |
An identifier that uniquely identifies all persons and organizations who perform medical services within the United States. This identifier is mandated by HIPAA and is maintained by CMS."An identifier that applies to this person in this role." - HL7 FHIR, Practitioner.identifier."Identifier assigned to the pharmacist by CMS. This number can be used to identify the pharmacist dispensing the medication." - ASAP Standard for PDMP, DSP14: Pharmacist National Provider Identifier (NPI)"Identifier assigned to the pharmacy by CMS." - ASAP Standard for PDMP, PHA01: National Provider Identifier (NPI)"Identifier assigned to the prescriber by CMS. " - ASAP Standard for PDMP, PRE01: National Provider Identifier (NPI) |
«CS» Code | providerCategory |
Contains a categorization for the practitioner.Kind of provider. "Defines the usage of this segment. X-12 DE 1221." - NCPDP Script (Field 4705) |
ProviderPlanParticipation | providerPlanParticipation |
Pointer to a participation of a Healthcare Provider (either an Individual or an Organizational Provider) with a Health Plan for the purpose of providing healthcare services to members (i.e., patients) of that plan. |
«CS» Code | providerRole |
"The list of Roles/Organizations that the Practitioner is associated with." - HL7 FHIR, Practitioner.practitionerRole. Note that FHIR does not identify any values for this concept. |
String | publicDigitalCertificate |
"A base 64 encoded representation of the public digital certificate" - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012. |
Specialty | specialty |
Pointer to the medical Specialty for which the Healthcare Provider has been certified."Specific specialty of the practitioner." - HL7 FHIR, Practitioner.practitionerRole.specialty. |
«II» Id | taxId |
An identifier assigned to the Healthcare Provider by a jurisdictional taxing authority. This id is often used for billing purposes."An identifier that applies to this person in this role." - HL7 FHIR, Practitioner.identifier. |
«TEL» ContactPoint | telecom |
Indicates how and at what address that the Healthcare Provider can be reached via electronic communications. The datatype for this property is ContactPoint, which can be used for telephone numbers as well as email, etc. The ContactPoint data type contains a type code to indicate what kind of telecommunications address that is being referenced. Note that this property can contain more than one entry."A contact detail for the practitioner, e.g. a telephone number or an email address." - HL7 FHIR, Practitioner.telecom."The prescriber's primary phone number" - ASAP Standard for PDMP, PRE08: Phone Number |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | HealthcareProvider |
Name Expression | |
Namespace | Provider |
Owned Template Signature | |
Owner | Provider |
Owning Template Parameter | |
Package | Provider |
Qualified Name | FHIM::Provider::HealthcareProvider |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public «AD» Address address
The physical location at which the Healthcare Provider is located or to which mail can be directed."The postal address where the practitioner can be found or visited or to which mail can be delivered." - HL7 FHIR, Practitioner.address.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | HealthcareProvider |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | address |
Name Expression | |
Namespace | HealthcareProvider |
Opposite | |
Owner | HealthcareProvider |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::HealthcareProvider::address |
Stereotype | |
Template Parameter | |
Type | «AD» Address |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public LicensedProvider asLlicensedProvider
Pointer to information about the Provider applicable to their Role of a Licensed Provider.
Aggregation | None |
Alias | |
Association | healthcareProvider_licensedProvider |
Association End | |
Class | HealthcareProvider |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | asLlicensedProvider |
Name Expression | |
Namespace | HealthcareProvider |
Opposite | |
Owner | HealthcareProvider |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::HealthcareProvider::asLlicensedProvider |
Stereotype | |
Template Parameter | |
Type | LicensedProvider |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public MedicaidProvider asMedicaidProvider
Pointer to information about the Provider applicable to their Role of a Medicaid Provider.
Aggregation | None |
Alias | |
Association | healthcareProvider_asMedicaidProvider |
Association End | |
Class | HealthcareProvider |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | asMedicaidProvider |
Name Expression | |
Namespace | HealthcareProvider |
Opposite | |
Owner | HealthcareProvider |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::HealthcareProvider::asMedicaidProvider |
Stereotype | |
Template Parameter | |
Type | MedicaidProvider |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public MedicareProvider asMedicareProvider
Pointer to information about the Provider applicable to their Role of a Medicare Provider.
Aggregation | None |
Alias | |
Association | healthcareProvider_asMedicareProvider |
Association End | |
Class | HealthcareProvider |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | asMedicareProvider |
Name Expression | |
Namespace | HealthcareProvider |
Opposite | |
Owner | HealthcareProvider |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::HealthcareProvider::asMedicareProvider |
Stereotype | |
Template Parameter | |
Type | MedicareProvider |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String digitalCertificateDistinguishedName
"Distinguished Name field from digital certificate" - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | HealthcareProvider |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | digitalCertificateDistinguishedName |
Name Expression | |
Namespace | HealthcareProvider |
Opposite | |
Owner | HealthcareProvider |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::HealthcareProvider::digitalCertificateDistinguishedName |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String digitalCertificateId
"Serial number from the public digital certificate" - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | HealthcareProvider |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | digitalCertificateId |
Name Expression | |
Namespace | HealthcareProvider |
Opposite | |
Owner | HealthcareProvider |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::HealthcareProvider::digitalCertificateId |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «II» Id identifier
Uniquely identifies the practitioner. This property should not contain the Tax Id or the National Provider Id, as these types of identifiers are modeled separately."An identifier that applies to this person in this role." - HL7 FHIR, Practitioner.identifier."The actual identification for the prescriber, pharmacist, et cetera, which is qualified by the Reference Qualifier." - NCPDP Script (Field 1154)"Defines the Reference number, field 1154. X-12 DE 128. One occurrence is the prescriber number. One occurrence may be used to identify the clinic. One occurrence may be used to identify a supervisor. If the prescriber has an NPI, one occurrence must contain the value HPI (NPI). If the prescriber has a DEA number, one occurrence must contain the value DH (DEA Number). Not every entity allowed to prescribe may have an NPI or DEA. If this is the case, the other identifiers can be used." - NCPDP Script (Field 1153). Possible values include: Certificate to Prescribe (CTP) number (the CTP is an additional number to the state license number that a board of pharmacy assigns to prescribing individuals after completion of specific requirements); DEA number; Dentist License Number; Medicaid Number; Medicare Number; NCPDP Provider ID Number; NPI - National Provider ID; Social Security Number; State License Number; etc.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | HealthcareProvider |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1..* |
Name | identifier |
Name Expression | |
Namespace | HealthcareProvider |
Opposite | |
Owner | HealthcareProvider |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::HealthcareProvider::identifier |
Stereotype | |
Template Parameter | |
Type | «II» Id |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public Boolean isActive
"Whether this practitioner's record is in active use." - HL7 FHIR, Practitioner.active.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | HealthcareProvider |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | isActive |
Name Expression | |
Namespace | HealthcareProvider |
Opposite | |
Owner | HealthcareProvider |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::HealthcareProvider::isActive |
Stereotype | |
Template Parameter | |
Type | Boolean |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «II» Id nationalProviderId
An identifier that uniquely identifies all persons and organizations who perform medical services within the United States. This identifier is mandated by HIPAA and is maintained by CMS."An identifier that applies to this person in this role." - HL7 FHIR, Practitioner.identifier."Identifier assigned to the pharmacist by CMS. This number can be used to identify the pharmacist dispensing the medication." - ASAP Standard for PDMP, DSP14: Pharmacist National Provider Identifier (NPI)"Identifier assigned to the pharmacy by CMS." - ASAP Standard for PDMP, PHA01: National Provider Identifier (NPI)"Identifier assigned to the prescriber by CMS. " - ASAP Standard for PDMP, PRE01: National Provider Identifier (NPI)
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | HealthcareProvider |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | nationalProviderId |
Name Expression | |
Namespace | HealthcareProvider |
Opposite | |
Owner | HealthcareProvider |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::HealthcareProvider::nationalProviderId |
Stereotype | |
Template Parameter | |
Type | «II» Id |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code providerCategory
Contains a categorization for the practitioner.Kind of provider. "Defines the usage of this segment. X-12 DE 1221." - NCPDP Script (Field 4705)
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | HealthcareProvider |
Terminologies | [ US_Core_R4 US Core Provider Role (NUCC) http://hl7.org/fhir/us/core/ValueSet/us-core-provider-role ] |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | providerCategory |
Name Expression | |
Namespace | HealthcareProvider |
Opposite | |
Owner | HealthcareProvider |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::HealthcareProvider::providerCategory |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public ProviderPlanParticipation providerPlanParticipation
Pointer to a participation of a Healthcare Provider (either an Individual or an Organizational Provider) with a Health Plan for the purpose of providing healthcare services to members (i.e., patients) of that plan.
Aggregation | None |
Alias | |
Association | healthcareProvider_providerPlanParticipation |
Association End | |
Class | HealthcareProvider |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | providerPlanParticipation |
Name Expression | |
Namespace | HealthcareProvider |
Opposite | healthcareProvider |
Owner | HealthcareProvider |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::HealthcareProvider::providerPlanParticipation |
Stereotype | |
Template Parameter | |
Type | ProviderPlanParticipation |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code providerRole
"The list of Roles/Organizations that the Practitioner is associated with." - HL7 FHIR, Practitioner.practitionerRole. Note that FHIR does not identify any values for this concept.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | HealthcareProvider |
Terminologies | [ C-CDA_2.1 Healthcare Provider Taxonomy 2.16.840.1.114222.4.11.1066 , HL7_FHIR_R4 Practitioner role http://hl7.org/fhir/ValueSet/practitioner-role , US_Core_R4 US Core Provider Specialty (NUCC) http://hl7.org/fhir/us/core/ValueSet/us-core-provider-specialty ] |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | providerRole |
Name Expression | |
Namespace | HealthcareProvider |
Opposite | |
Owner | HealthcareProvider |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::HealthcareProvider::providerRole |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String publicDigitalCertificate
"A base 64 encoded representation of the public digital certificate" - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | HealthcareProvider |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | publicDigitalCertificate |
Name Expression | |
Namespace | HealthcareProvider |
Opposite | |
Owner | HealthcareProvider |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::HealthcareProvider::publicDigitalCertificate |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Specialty specialty
Pointer to the medical Specialty for which the Healthcare Provider has been certified."Specific specialty of the practitioner." - HL7 FHIR, Practitioner.practitionerRole.specialty.
Aggregation | None |
Alias | |
Association | healthcareProvider_specialty |
Association End | |
Class | HealthcareProvider |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | false |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | specialty |
Name Expression | |
Namespace | HealthcareProvider |
Opposite | |
Owner | HealthcareProvider |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::HealthcareProvider::specialty |
Stereotype | |
Template Parameter | |
Type | Specialty |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «II» Id taxId
An identifier assigned to the Healthcare Provider by a jurisdictional taxing authority. This id is often used for billing purposes."An identifier that applies to this person in this role." - HL7 FHIR, Practitioner.identifier.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | HealthcareProvider |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | taxId |
Name Expression | |
Namespace | HealthcareProvider |
Opposite | |
Owner | HealthcareProvider |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::HealthcareProvider::taxId |
Stereotype | |
Template Parameter | |
Type | «II» Id |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «TEL» ContactPoint telecom
Indicates how and at what address that the Healthcare Provider can be reached via electronic communications. The datatype for this property is ContactPoint, which can be used for telephone numbers as well as email, etc. The ContactPoint data type contains a type code to indicate what kind of telecommunications address that is being referenced. Note that this property can contain more than one entry."A contact detail for the practitioner, e.g. a telephone number or an email address." - HL7 FHIR, Practitioner.telecom."The prescriber's primary phone number" - ASAP Standard for PDMP, PRE08: Phone Number
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | HealthcareProvider |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | telecom |
Name Expression | |
Namespace | HealthcareProvider |
Opposite | |
Owner | HealthcareProvider |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::HealthcareProvider::telecom |
Stereotype | |
Template Parameter | |
Type | «TEL» ContactPoint |
Upper | * |
Upper Value | (*) |
Visibility | Public |
| Provider UML Documentation |
Summary:AttributesProperties | Detail:Attributes |