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-current 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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Extension: NDH Rating

This extension enables NDH to represent ratings for services, organizations, practitioners, and roles, with structured support for rating type, quantitative or textual values, and optional nested RatingDetails for richer comparative quality signals; it is used in HealthcareService, Organization, Practitioner, and PractitionerRole.

Context of Use

This extension may be used on the following element(s)

• Element ID: HealthcareService
• Element ID: Organization
• Element ID: Practitioner
• Element ID: PractitionerRole

Usage info

Usages:

• Use this Extension: NDH HealthcareService Profile, NDH Organization Profile, NDH Practitioner Profile and NDH PractitionerRole
• Examples for this Extension: HealthcareService/BurrClinicServices and Example Rated Hospital

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description Differentials, Snapshots, and other representations.

• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Extension		0..*	Extension	NDH Rating
Slices for extension				Content/Rules for all slices
extension:ratingType		0..1	Extension	Rating type
extension		0..0		Extension
url		1..1	uri	"ratingType"
value[x]		0..1	CodeableConcept	Rating type value set will be defined by the implementer Binding: NDH Example Rating Type Value Set (example)
extension:ratingValue		0..1	Extension	Rating Value either Text or Number
extension		0..0		Extension
url		1..1	uri	"ratingValue"
value[x]		1..1		Value of extension
valueString			string
valueQuantity			Quantity
extension:rating-details		0..*	(Complex)	Rating Details URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating-details
url		1..1	uri	"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating"
value[x]		0..0		Value of extension
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Extension.extension:ratingType.​value[x]	Base	example	NDH Example Rating Type Value Set	📦2.0.0-current	This IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Extension		0..*	Extension	NDH Rating
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:ratingType		0..1	Extension	Rating type
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"ratingType"
value[x]		0..1	CodeableConcept	Rating type value set will be defined by the implementer Binding: NDH Example Rating Type Value Set (example)
extension:ratingValue		0..1	Extension	Rating Value either Text or Number
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"ratingValue"
value[x]		1..1		Value of extension
valueString			string
valueQuantity			Quantity
extension:rating-details		0..*	(Complex)	Rating Details URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating-details
url		1..1	uri	"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating"
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Extension.extension:ratingType.​value[x]	Base	example	NDH Example Rating Type Value Set	📦2.0.0-current	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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()

Summary

Complex Extension: This extension enables NDH to represent ratings for services, organizations, practitioners, and roles, with structured support for rating type, quantitative or textual values, and optional nested RatingDetails for richer comparative quality signals; it is used in HealthcareService, Organization, Practitioner, and PractitionerRole.

• ratingType: CodeableConcept: An Extension
• ratingValue: string, Quantity: An Extension

Maturity: 4

Differential ViewDifferential View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Extension		0..*	Extension	NDH Rating
Slices for extension				Content/Rules for all slices
extension:ratingType		0..1	Extension	Rating type
extension		0..0		Extension
url		1..1	uri	"ratingType"
value[x]		0..1	CodeableConcept	Rating type value set will be defined by the implementer Binding: NDH Example Rating Type Value Set (example)
extension:ratingValue		0..1	Extension	Rating Value either Text or Number
extension		0..0		Extension
url		1..1	uri	"ratingValue"
value[x]		1..1		Value of extension
valueString			string
valueQuantity			Quantity
extension:rating-details		0..*	(Complex)	Rating Details URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating-details
url		1..1	uri	"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating"
value[x]		0..0		Value of extension
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Extension.extension:ratingType.​value[x]	Base	example	NDH Example Rating Type Value Set	📦2.0.0-current	This IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Extension		0..*	Extension	NDH Rating
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:ratingType		0..1	Extension	Rating type
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"ratingType"
value[x]		0..1	CodeableConcept	Rating type value set will be defined by the implementer Binding: NDH Example Rating Type Value Set (example)
extension:ratingValue		0..1	Extension	Rating Value either Text or Number
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"ratingValue"
value[x]		1..1		Value of extension
valueString			string
valueQuantity			Quantity
extension:rating-details		0..*	(Complex)	Rating Details URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating-details
url		1..1	uri	"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating"
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Extension.extension:ratingType.​value[x]	Base	example	NDH Example Rating Type Value Set	📦2.0.0-current	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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()

Summary

Complex Extension: This extension enables NDH to represent ratings for services, organizations, practitioners, and roles, with structured support for rating type, quantitative or textual values, and optional nested RatingDetails for richer comparative quality signals; it is used in HealthcareService, Organization, Practitioner, and PractitionerRole.

• ratingType: CodeableConcept: An Extension
• ratingValue: string, Quantity: An Extension

Maturity: 4

Other representations of profile: CSV, Excel, Schematron