National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0-current - ci-build United States of America flag

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

Extension: NDH Rating Details

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating-details Version: 2.0.0-current
Standards status: Trial-use Maturity Level: 4 Computable Name: RatingDetails
Other Identifiers: OID:2.16.840.1.113883.4.642.40.43.42.32

This extension enables NDH to carry supplemental rating metadata, including rating system, rating type, and rating value, so implementer-defined scoring models can be represented with clearer provenance and meaning; it is used as a nested extension within base-ext-rating.

Context of Use

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

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description Differentials, Snapshots, and other representations.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension NDH Rating Details
Extension.Slices for extension Content/Rules for all slices
Extension.Slices for extension.extension:ratingSystem 0..1 Extension URL to a specific rating system
Extension.Slices for extension.extension:ratingSystem.extension 0..0 Extension
Extension.Slices for extension.extension:ratingSystem.url 1..1 uri "ratingSystem"
Extension.Slices for extension.extension:ratingSystem.value[x] 0..1 url Value of extension
Extension.Slices for extension.extension:ratingType 0..1 Extension URL to a specific rating type
Extension.Slices for extension.extension:ratingType.extension 0..0 Extension
Extension.Slices for extension.extension:ratingType.url 1..1 uri "ratingType"
Extension.Slices for extension.extension:ratingType.value[x] 0..1 url Value of extension
Extension.Slices for extension.extension:ratingValue 0..1 Extension Rating Value either Text or Number
Extension.Slices for extension.extension:ratingValue.extension 0..0 Extension
Extension.Slices for extension.extension:ratingValue.url 1..1 uri "ratingValue"
Extension.Slices for extension.extension:ratingValue.value[x] 0..1 Value of extension
Extension.Slices for extension.extension:ratingValue.value[x].valueString string
Extension.Slices for extension.extension:ratingValue.value[x].valueQuantity Quantity
Extension.url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating-details"
Extension.value[x] 0..0 Value of extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension NDH Rating Details
Extension.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Extension.Slices for extension.extension:ratingSystem 0..1 Extension URL to a specific rating system
Extension.Slices for extension.extension:ratingSystem.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ratingSystem.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:ratingSystem.url 1..1 uri "ratingSystem"
Extension.Slices for extension.extension:ratingSystem.value[x] 0..1 url Value of extension
Extension.Slices for extension.extension:ratingType 0..1 Extension URL to a specific rating type
Extension.Slices for extension.extension:ratingType.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ratingType.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:ratingType.url 1..1 uri "ratingType"
Extension.Slices for extension.extension:ratingType.value[x] 0..1 url Value of extension
Extension.Slices for extension.extension:ratingValue 0..1 Extension Rating Value either Text or Number
Extension.Slices for extension.extension:ratingValue.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ratingValue.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:ratingValue.url 1..1 uri "ratingValue"
Extension.Slices for extension.extension:ratingValue.value[x] 0..1 Value of extension
Extension.Slices for extension.extension:ratingValue.value[x].valueString string
Extension.Slices for extension.extension:ratingValue.value[x].valueQuantity Quantity
Extension.url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating-details"

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Extension

Summary

Complex Extension: This extension enables NDH to carry supplemental rating metadata, including rating system, rating type, and rating value, so implementer-defined scoring models can be represented with clearer provenance and meaning; it is used as a nested extension within base-ext-rating.

  • ratingSystem: url: An Extension
  • ratingType: url: An Extension
  • ratingValue: string, Quantity: An Extension

Maturity: 4

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension NDH Rating Details
Extension.Slices for extension Content/Rules for all slices
Extension.Slices for extension.extension:ratingSystem 0..1 Extension URL to a specific rating system
Extension.Slices for extension.extension:ratingSystem.extension 0..0 Extension
Extension.Slices for extension.extension:ratingSystem.url 1..1 uri "ratingSystem"
Extension.Slices for extension.extension:ratingSystem.value[x] 0..1 url Value of extension
Extension.Slices for extension.extension:ratingType 0..1 Extension URL to a specific rating type
Extension.Slices for extension.extension:ratingType.extension 0..0 Extension
Extension.Slices for extension.extension:ratingType.url 1..1 uri "ratingType"
Extension.Slices for extension.extension:ratingType.value[x] 0..1 url Value of extension
Extension.Slices for extension.extension:ratingValue 0..1 Extension Rating Value either Text or Number
Extension.Slices for extension.extension:ratingValue.extension 0..0 Extension
Extension.Slices for extension.extension:ratingValue.url 1..1 uri "ratingValue"
Extension.Slices for extension.extension:ratingValue.value[x] 0..1 Value of extension
Extension.Slices for extension.extension:ratingValue.value[x].valueString string
Extension.Slices for extension.extension:ratingValue.value[x].valueQuantity Quantity
Extension.url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating-details"
Extension.value[x] 0..0 Value of extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension NDH Rating Details
Extension.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Extension.Slices for extension.extension:ratingSystem 0..1 Extension URL to a specific rating system
Extension.Slices for extension.extension:ratingSystem.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ratingSystem.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:ratingSystem.url 1..1 uri "ratingSystem"
Extension.Slices for extension.extension:ratingSystem.value[x] 0..1 url Value of extension
Extension.Slices for extension.extension:ratingType 0..1 Extension URL to a specific rating type
Extension.Slices for extension.extension:ratingType.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ratingType.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:ratingType.url 1..1 uri "ratingType"
Extension.Slices for extension.extension:ratingType.value[x] 0..1 url Value of extension
Extension.Slices for extension.extension:ratingValue 0..1 Extension Rating Value either Text or Number
Extension.Slices for extension.extension:ratingValue.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ratingValue.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:ratingValue.url 1..1 uri "ratingValue"
Extension.Slices for extension.extension:ratingValue.value[x] 0..1 Value of extension
Extension.Slices for extension.extension:ratingValue.value[x].valueString string
Extension.Slices for extension.extension:ratingValue.value[x].valueQuantity Quantity
Extension.url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating-details"

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Extension

Summary

Complex Extension: This extension enables NDH to carry supplemental rating metadata, including rating system, rating type, and rating value, so implementer-defined scoring models can be represented with clearer provenance and meaning; it is used as a nested extension within base-ext-rating.

  • ratingSystem: url: An Extension
  • ratingType: url: An Extension
  • ratingValue: string, Quantity: An Extension

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron