National Directory of Healthcare Providers & Services (NDH) Implementation Guide, published by HL7 International / Patient Administration. 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/fhir-us-ndh/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-PractitionerRole | Version: 2.0.0 | |||
Standards status: Trial-use | Computable Name: NdhNdApiPractitionerRole |
PractitionerRole describes details about a provider, which can be a practitioner or an organization. When the provider is a practitioner, there may be a relationship to an organization. A provider renders services to patients at a location. Practitioner participation in healthcare provider insurance networks may be direct or through their role at an organization.
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | NdhPractitionerRole | Roles/organizations the practitioner is associated with Constraints: pd-1, us-core-13, practitioner-or-organization-or-healthcareservice-or-location |
![]() ![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
Σ | 1..1 | instant | When the resource version last changed |
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating |
![]() ![]() ![]() ![]() |
SC | 0..* | (Complex) | NDH New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients Constraints: new-patients-characteristics |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | NDH Network Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference" | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(National Directory API Network Profile) | Value of extension |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Digitalcertificate URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Business Identifiers that are specific to a role/location |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
SΣ | 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. |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(National Directory API Organization Profile) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
SΣ | 1..1 | boolean | Whether this practitioner role record is in active use Required Pattern: true |
![]() ![]() ![]() |
SΣ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
![]() ![]() ![]() |
SΣC | 0..1 | Reference(National Directory API Practitioner Profile) | Practitioner that is able to provide the defined services for the organization |
![]() ![]() ![]() |
SΣC | 0..1 | Reference(National Directory API Organization Profile) | Organization where the role is available |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Slice: Unordered, Open by value:$this Binding: Care Team Member Function ![]() |
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | NDH PractitionerRole Code Binding: PractitionerRole Code Value Set (required) |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Individual and Group Specialties (extensible) |
![]() ![]() ![]() |
SΣC | 0..* | Reference(National Directory API Location Profile) | The location(s) at which this practitioner provides care |
![]() ![]() ![]() |
SC | 0..* | Reference(National Directory API HealthcareService Profile) | The list of healthcare services that this worker provides for this role's Organization/Location(s) |
![]() ![]() ![]() |
SΣC | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Times the Service Site is available |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. |
![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Always available? e.g. 24 hour service |
![]() ![]() ![]() ![]() |
S | 0..1 | time | Opening time of day (ignored if allDay = true) |
![]() ![]() ![]() ![]() |
S | 0..1 | time | Closing time of day (ignored if allDay = true) |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Not available during this time due to provided reason |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Reason presented to the user explaining why time not available |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Service not available from this date |
![]() ![]() ![]() |
SC | 0..* | Reference(National Directory API Endpoint Profile) | Technical endpoints providing access to services operated for the practitioner with this role |
![]() |
Path | Conformance | ValueSet | URI |
PractitionerRole.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard | |
PractitionerRole.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard | |
PractitionerRole.code | extensible | CareTeamMemberFunction ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 | |
PractitionerRole.code:NDHPractitionerRoleCode | required | PractitionerRoleVS(a valid code from NDH Practitioner Role Codes Code System)http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVS From this IG | |
PractitionerRole.specialty | extensible | IndividualAndGroupSpecialtiesVShttp://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS From this IG | |
PractitionerRole.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard | |
PractitionerRole.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard | |
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | PractitionerRole | 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 | PractitionerRole | 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 | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | PractitionerRole | 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() | |
new-patients-characteristics | error | PractitionerRole.extension:newpatients | If no new patients are accepted, no characteristics are allowed : extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients').value.coding.exists(code = 'nopt') implies extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients-characteristics').empty() | |
pd-1 | error | PractitionerRole | SHALL have contact information or a reference to an Endpoint : telecom or endpoint | |
practitioner-or-organization-or-healthcareservice-or-location | error | PractitionerRole | If NdhPractitionerRole.practitioner is absent ( NdhPractitionerRole.organization, NdhPractitionerRole.healthcareservice, NdhPractitionerRole.location)
must be present : practitioner.exists() or (organization.exists() or healthcareService.exists() or location.exists()) | |
us-core-13 | error | PractitionerRole | SHALL have a practitioner, an organization, a healthcare service, or a location. : practitioner or organization or healthcareService or location |
This structure is derived from NdhPractitionerRole
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
NdhPractitionerRole | |||
![]() ![]() ![]() |
S | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
![]() ![]() ![]() |
1..* | Extension | Extension | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..* | Rating | NDH Rating |
![]() ![]() ![]() ![]() |
S | 0..* | NewPatients | NDH New Patients |
![]() ![]() ![]() ![]() |
S | 0..1 | NetworkReference | NDH Network Reference |
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(National Directory API Network Profile) | Value of extension | |
![]() ![]() ![]() ![]() |
S | 0..* | Digitalcertificate | NDH Digitalcertificate |
![]() ![]() ![]() ![]() |
S | 0..* | Qualification | NDH Qualification |
![]() ![]() ![]() ![]() |
S | 1..1 | VerificationStatus | NDH Verification Status |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | IdentifierStatus | NDH Identifier Status |
![]() ![]() ![]() ![]() |
S | 0..1 | code | usual | official | temp | secondary | old (If known) |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() |
S | 0..1 | string | The value that is unique |
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(National Directory API Organization Profile) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
S | 1..1 | boolean | Whether this practitioner role record is in active use |
![]() ![]() ![]() |
S | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
![]() ![]() ![]() |
0..1 | Reference(National Directory API Practitioner Profile) | Practitioner that is able to provide the defined services for the organization | |
![]() ![]() ![]() |
0..1 | Reference(National Directory API Organization Profile) | Organization where the role is available | |
![]() ![]() ![]() |
0..* | Reference(National Directory API Location Profile) | The location(s) at which this practitioner provides care | |
![]() ![]() ![]() |
0..* | Reference(National Directory API HealthcareService Profile) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | ContactPointAvailableTime | NDH Contactpoint Availabletime |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | ViaIntermediary | NDH Via Intermediary |
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Times the Service Site is available |
![]() ![]() ![]() ![]() |
S | 0..* | code | mon | tue | wed | thu | fri | sat | sun |
![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Always available? e.g. 24 hour service |
![]() ![]() ![]() ![]() |
S | 0..1 | time | Opening time of day (ignored if allDay = true) |
![]() ![]() ![]() ![]() |
S | 0..1 | time | Closing time of day (ignored if allDay = true) |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Not available during this time due to provided reason |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Reason presented to the user explaining why time not available |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Service not available from this date |
![]() ![]() ![]() |
0..* | Reference(National Directory API Endpoint Profile) | Technical endpoints providing access to services operated for the practitioner with this role | |
![]() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | NdhPractitionerRole | Roles/organizations the practitioner is associated with Constraints: pd-1, us-core-13, practitioner-or-organization-or-healthcareservice-or-location | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating | ||||
![]() ![]() ![]() ![]() |
SC | 0..* | (Complex) | NDH New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients Constraints: new-patients-characteristics | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | NDH Network Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference" | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(National Directory API Network Profile) | Value of extension | ||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Digitalcertificate URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate | ||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Business Identifiers that are specific to a role/location | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
SΣ | 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. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(National Directory API Organization Profile) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | boolean | Whether this practitioner role record is in active use Required Pattern: true | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||
![]() ![]() ![]() |
SΣC | 0..1 | Reference(National Directory API Practitioner Profile) | Practitioner that is able to provide the defined services for the organization | ||||
![]() ![]() ![]() |
SΣC | 0..1 | Reference(National Directory API Organization Profile) | Organization where the role is available | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Slice: Unordered, Open by value:$this Binding: Care Team Member Function ![]() | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | NDH PractitionerRole Code Binding: PractitionerRole Code Value Set (required) | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Individual and Group Specialties (extensible) | ||||
![]() ![]() ![]() |
SΣC | 0..* | Reference(National Directory API Location Profile) | The location(s) at which this practitioner provides care | ||||
![]() ![]() ![]() |
SC | 0..* | Reference(National Directory API HealthcareService Profile) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | ||||
![]() ![]() ![]() |
SΣC | 0..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Times the Service Site is available | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Always available? e.g. 24 hour service | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | time | Opening time of day (ignored if allDay = true) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | time | Closing time of day (ignored if allDay = true) | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Not available during this time due to provided reason | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Reason presented to the user explaining why time not available | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Service not available from this date | ||||
![]() ![]() ![]() |
0..1 | string | Description of availability exceptions | |||||
![]() ![]() ![]() |
SC | 0..* | Reference(National Directory API Endpoint Profile) | Technical endpoints providing access to services operated for the practitioner with this role | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
PractitionerRole.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard | ||||
PractitionerRole.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard | ||||
PractitionerRole.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
PractitionerRole.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard | ||||
PractitionerRole.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard | ||||
PractitionerRole.code | extensible | CareTeamMemberFunction ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 | ||||
PractitionerRole.code:NDHPractitionerRoleCode | required | PractitionerRoleVS(a valid code from NDH Practitioner Role Codes Code System)http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVS From this IG | ||||
PractitionerRole.specialty | extensible | IndividualAndGroupSpecialtiesVShttp://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS From this IG | ||||
PractitionerRole.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard | ||||
PractitionerRole.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard | ||||
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | PractitionerRole | 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 | PractitionerRole | 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 | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | PractitionerRole | 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() | |
new-patients-characteristics | error | PractitionerRole.extension:newpatients | If no new patients are accepted, no characteristics are allowed : extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients').value.coding.exists(code = 'nopt') implies extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients-characteristics').empty() | |
pd-1 | error | PractitionerRole | SHALL have contact information or a reference to an Endpoint : telecom or endpoint | |
practitioner-or-organization-or-healthcareservice-or-location | error | PractitionerRole | If NdhPractitionerRole.practitioner is absent ( NdhPractitionerRole.organization, NdhPractitionerRole.healthcareservice, NdhPractitionerRole.location)
must be present : practitioner.exists() or (organization.exists() or healthcareService.exists() or location.exists()) | |
us-core-13 | error | PractitionerRole | SHALL have a practitioner, an organization, a healthcare service, or a location. : practitioner or organization or healthcareService or location |
This structure is derived from NdhPractitionerRole
Summary
Mandatory: 2 elements(3 nested mandatory elements)
Must-Support: 26 elements
Structures
This structure refers to these other structures:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | NdhPractitionerRole | Roles/organizations the practitioner is associated with Constraints: pd-1, us-core-13, practitioner-or-organization-or-healthcareservice-or-location |
![]() ![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
Σ | 1..1 | instant | When the resource version last changed |
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating |
![]() ![]() ![]() ![]() |
SC | 0..* | (Complex) | NDH New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients Constraints: new-patients-characteristics |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | NDH Network Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference" | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(National Directory API Network Profile) | Value of extension |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Digitalcertificate URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Business Identifiers that are specific to a role/location |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
SΣ | 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. |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(National Directory API Organization Profile) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
SΣ | 1..1 | boolean | Whether this practitioner role record is in active use Required Pattern: true |
![]() ![]() ![]() |
SΣ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
![]() ![]() ![]() |
SΣC | 0..1 | Reference(National Directory API Practitioner Profile) | Practitioner that is able to provide the defined services for the organization |
![]() ![]() ![]() |
SΣC | 0..1 | Reference(National Directory API Organization Profile) | Organization where the role is available |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Slice: Unordered, Open by value:$this Binding: Care Team Member Function ![]() |
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | NDH PractitionerRole Code Binding: PractitionerRole Code Value Set (required) |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Individual and Group Specialties (extensible) |
![]() ![]() ![]() |
SΣC | 0..* | Reference(National Directory API Location Profile) | The location(s) at which this practitioner provides care |
![]() ![]() ![]() |
SC | 0..* | Reference(National Directory API HealthcareService Profile) | The list of healthcare services that this worker provides for this role's Organization/Location(s) |
![]() ![]() ![]() |
SΣC | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Times the Service Site is available |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. |
![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Always available? e.g. 24 hour service |
![]() ![]() ![]() ![]() |
S | 0..1 | time | Opening time of day (ignored if allDay = true) |
![]() ![]() ![]() ![]() |
S | 0..1 | time | Closing time of day (ignored if allDay = true) |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Not available during this time due to provided reason |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Reason presented to the user explaining why time not available |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Service not available from this date |
![]() ![]() ![]() |
SC | 0..* | Reference(National Directory API Endpoint Profile) | Technical endpoints providing access to services operated for the practitioner with this role |
![]() |
Path | Conformance | ValueSet | URI |
PractitionerRole.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard | |
PractitionerRole.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard | |
PractitionerRole.code | extensible | CareTeamMemberFunction ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 | |
PractitionerRole.code:NDHPractitionerRoleCode | required | PractitionerRoleVS(a valid code from NDH Practitioner Role Codes Code System)http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVS From this IG | |
PractitionerRole.specialty | extensible | IndividualAndGroupSpecialtiesVShttp://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS From this IG | |
PractitionerRole.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard | |
PractitionerRole.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard | |
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | PractitionerRole | 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 | PractitionerRole | 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 | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | PractitionerRole | 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() | |
new-patients-characteristics | error | PractitionerRole.extension:newpatients | If no new patients are accepted, no characteristics are allowed : extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients').value.coding.exists(code = 'nopt') implies extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients-characteristics').empty() | |
pd-1 | error | PractitionerRole | SHALL have contact information or a reference to an Endpoint : telecom or endpoint | |
practitioner-or-organization-or-healthcareservice-or-location | error | PractitionerRole | If NdhPractitionerRole.practitioner is absent ( NdhPractitionerRole.organization, NdhPractitionerRole.healthcareservice, NdhPractitionerRole.location)
must be present : practitioner.exists() or (organization.exists() or healthcareService.exists() or location.exists()) | |
us-core-13 | error | PractitionerRole | SHALL have a practitioner, an organization, a healthcare service, or a location. : practitioner or organization or healthcareService or location |
Differential View
This structure is derived from NdhPractitionerRole
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
NdhPractitionerRole | |||
![]() ![]() ![]() |
S | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
![]() ![]() ![]() |
1..* | Extension | Extension | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..* | Rating | NDH Rating |
![]() ![]() ![]() ![]() |
S | 0..* | NewPatients | NDH New Patients |
![]() ![]() ![]() ![]() |
S | 0..1 | NetworkReference | NDH Network Reference |
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(National Directory API Network Profile) | Value of extension | |
![]() ![]() ![]() ![]() |
S | 0..* | Digitalcertificate | NDH Digitalcertificate |
![]() ![]() ![]() ![]() |
S | 0..* | Qualification | NDH Qualification |
![]() ![]() ![]() ![]() |
S | 1..1 | VerificationStatus | NDH Verification Status |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | IdentifierStatus | NDH Identifier Status |
![]() ![]() ![]() ![]() |
S | 0..1 | code | usual | official | temp | secondary | old (If known) |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() |
S | 0..1 | string | The value that is unique |
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(National Directory API Organization Profile) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
S | 1..1 | boolean | Whether this practitioner role record is in active use |
![]() ![]() ![]() |
S | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
![]() ![]() ![]() |
0..1 | Reference(National Directory API Practitioner Profile) | Practitioner that is able to provide the defined services for the organization | |
![]() ![]() ![]() |
0..1 | Reference(National Directory API Organization Profile) | Organization where the role is available | |
![]() ![]() ![]() |
0..* | Reference(National Directory API Location Profile) | The location(s) at which this practitioner provides care | |
![]() ![]() ![]() |
0..* | Reference(National Directory API HealthcareService Profile) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | ContactPointAvailableTime | NDH Contactpoint Availabletime |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | ViaIntermediary | NDH Via Intermediary |
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Times the Service Site is available |
![]() ![]() ![]() ![]() |
S | 0..* | code | mon | tue | wed | thu | fri | sat | sun |
![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Always available? e.g. 24 hour service |
![]() ![]() ![]() ![]() |
S | 0..1 | time | Opening time of day (ignored if allDay = true) |
![]() ![]() ![]() ![]() |
S | 0..1 | time | Closing time of day (ignored if allDay = true) |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Not available during this time due to provided reason |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Reason presented to the user explaining why time not available |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Service not available from this date |
![]() ![]() ![]() |
0..* | Reference(National Directory API Endpoint Profile) | Technical endpoints providing access to services operated for the practitioner with this role | |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | NdhPractitionerRole | Roles/organizations the practitioner is associated with Constraints: pd-1, us-core-13, practitioner-or-organization-or-healthcareservice-or-location | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating | ||||
![]() ![]() ![]() ![]() |
SC | 0..* | (Complex) | NDH New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients Constraints: new-patients-characteristics | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | NDH Network Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference" | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(National Directory API Network Profile) | Value of extension | ||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Digitalcertificate URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate | ||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Business Identifiers that are specific to a role/location | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
SΣ | 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. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(National Directory API Organization Profile) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | boolean | Whether this practitioner role record is in active use Required Pattern: true | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||
![]() ![]() ![]() |
SΣC | 0..1 | Reference(National Directory API Practitioner Profile) | Practitioner that is able to provide the defined services for the organization | ||||
![]() ![]() ![]() |
SΣC | 0..1 | Reference(National Directory API Organization Profile) | Organization where the role is available | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Slice: Unordered, Open by value:$this Binding: Care Team Member Function ![]() | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | NDH PractitionerRole Code Binding: PractitionerRole Code Value Set (required) | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Individual and Group Specialties (extensible) | ||||
![]() ![]() ![]() |
SΣC | 0..* | Reference(National Directory API Location Profile) | The location(s) at which this practitioner provides care | ||||
![]() ![]() ![]() |
SC | 0..* | Reference(National Directory API HealthcareService Profile) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | ||||
![]() ![]() ![]() |
SΣC | 0..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Times the Service Site is available | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Always available? e.g. 24 hour service | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | time | Opening time of day (ignored if allDay = true) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | time | Closing time of day (ignored if allDay = true) | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Not available during this time due to provided reason | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Reason presented to the user explaining why time not available | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Service not available from this date | ||||
![]() ![]() ![]() |
0..1 | string | Description of availability exceptions | |||||
![]() ![]() ![]() |
SC | 0..* | Reference(National Directory API Endpoint Profile) | Technical endpoints providing access to services operated for the practitioner with this role | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
PractitionerRole.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard | ||||
PractitionerRole.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard | ||||
PractitionerRole.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
PractitionerRole.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard | ||||
PractitionerRole.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard | ||||
PractitionerRole.code | extensible | CareTeamMemberFunction ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 | ||||
PractitionerRole.code:NDHPractitionerRoleCode | required | PractitionerRoleVS(a valid code from NDH Practitioner Role Codes Code System)http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVS From this IG | ||||
PractitionerRole.specialty | extensible | IndividualAndGroupSpecialtiesVShttp://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS From this IG | ||||
PractitionerRole.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard | ||||
PractitionerRole.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard | ||||
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | PractitionerRole | 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 | PractitionerRole | 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 | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | PractitionerRole | 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() | |
new-patients-characteristics | error | PractitionerRole.extension:newpatients | If no new patients are accepted, no characteristics are allowed : extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients').value.coding.exists(code = 'nopt') implies extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients-characteristics').empty() | |
pd-1 | error | PractitionerRole | SHALL have contact information or a reference to an Endpoint : telecom or endpoint | |
practitioner-or-organization-or-healthcareservice-or-location | error | PractitionerRole | If NdhPractitionerRole.practitioner is absent ( NdhPractitionerRole.organization, NdhPractitionerRole.healthcareservice, NdhPractitionerRole.location)
must be present : practitioner.exists() or (organization.exists() or healthcareService.exists() or location.exists()) | |
us-core-13 | error | PractitionerRole | SHALL have a practitioner, an organization, a healthcare service, or a location. : practitioner or organization or healthcareService or location |
This structure is derived from NdhPractitionerRole
Summary
Mandatory: 2 elements(3 nested mandatory elements)
Must-Support: 26 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron