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 Implementation Guide Supported

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-implementation-guide Version: 2.0.0-current
Standards status: Trial-use Maturity Level: 4 Computable Name: ImplementationGuideSupported
Other Identifiers: OID:2.16.840.1.113883.4.642.40.43.42.17

This extension enables NDH to declare implementation-guide compatibility for endpoints when standard connection-type coding does not fully describe behavior, using structured sub-extensions for IG URI, name, use case, version, actor, and options with extensible use-case binding to NdhImplementationGuideVS; it is used in Endpoint.

Context of Use

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

Implementation Guide Supported, when the connectionType and EndpointIheSpecificConnectionType Extension can't be used.

  • ig-uri is a canonical for the Implementation Guide
  • ig-name is a string that provides the name of the IG
  • ig-usecase is a CodeableConcept that provides the use-case that is addressed by the named implementation guide
  • ig-version is a string that provides the version of the IG
  • ig-actor is a string that provides the actor (e.g., sender, receiver) from the IG that is supported
  • ig-option is a string that indicates a named option for that actor in that IG (e.g., "Asynchronous Web Services Exchange" option for the Initiating Gateway actor in the IHE XCPD profile) The IG SHOULD be indicated by at-least ig-uri, or ig-name.

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 Implementation Guide Supported
Extension.Slices for extension Content/Rules for all slices
Extension.Slices for extension.extension:ig-uri 0..1 Extension IG Publication URI
Extension.Slices for extension.extension:ig-uri.extension 0..0 Extension
Extension.Slices for extension.extension:ig-uri.url 1..1 uri "ig-uri"
Extension.Slices for extension.extension:ig-uri.value[x] 0..1 canonical() Value of extension
Extension.Slices for extension.extension:ig-name 0..1 Extension IG Name
Extension.Slices for extension.extension:ig-name.extension 0..0 Extension
Extension.Slices for extension.extension:ig-name.url 1..1 uri "ig-name"
Extension.Slices for extension.extension:ig-name.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:ig-usecase 0..* Extension IG Use Case
Extension.Slices for extension.extension:ig-usecase.extension 0..0 Extension
Extension.Slices for extension.extension:ig-usecase.url 1..1 uri "ig-usecase"
Extension.Slices for extension.extension:ig-usecase.value[x] 0..1 CodeableConcept Value of extension
Binding: NDH endpoint Implementation Guide Value Set (extensible)
Extension.Slices for extension.extension:ig-version 0..1 Extension IG Version
Extension.Slices for extension.extension:ig-version.extension 0..0 Extension
Extension.Slices for extension.extension:ig-version.url 1..1 uri "ig-version"
Extension.Slices for extension.extension:ig-version.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:ig-actor 0..* Extension IG Actor
Extension.Slices for extension.extension:ig-actor.extension 0..0 Extension
Extension.Slices for extension.extension:ig-actor.url 1..1 uri "ig-actor"
Extension.Slices for extension.extension:ig-actor.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:ig-option 0..* Extension IG Option
Extension.Slices for extension.extension:ig-option.extension 0..0 Extension
Extension.Slices for extension.extension:ig-option.url 1..1 uri "ig-option"
Extension.Slices for extension.extension:ig-option.value[x] 0..1 string Value of extension
Extension.url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-implementation-guide"
Extension.value[x] 0..0 Value of extension

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Extension.extension:ig-usecase.​value[x] Base extensible NDH endpoint Implementation Guide Value Set 📦2.0.0-current This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension NDH Implementation Guide Supported
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:ig-uri 0..1 Extension IG Publication URI
Extension.Slices for extension.extension:ig-uri.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ig-uri.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:ig-uri.url 1..1 uri "ig-uri"
Extension.Slices for extension.extension:ig-uri.value[x] 0..1 canonical() Value of extension
Extension.Slices for extension.extension:ig-name 0..1 Extension IG Name
Extension.Slices for extension.extension:ig-name.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ig-name.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:ig-name.url 1..1 uri "ig-name"
Extension.Slices for extension.extension:ig-name.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:ig-usecase 0..* Extension IG Use Case
Extension.Slices for extension.extension:ig-usecase.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ig-usecase.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:ig-usecase.url 1..1 uri "ig-usecase"
Extension.Slices for extension.extension:ig-usecase.value[x] 0..1 CodeableConcept Value of extension
Binding: NDH endpoint Implementation Guide Value Set (extensible)
Extension.Slices for extension.extension:ig-version 0..1 Extension IG Version
Extension.Slices for extension.extension:ig-version.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ig-version.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:ig-version.url 1..1 uri "ig-version"
Extension.Slices for extension.extension:ig-version.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:ig-actor 0..* Extension IG Actor
Extension.Slices for extension.extension:ig-actor.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ig-actor.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:ig-actor.url 1..1 uri "ig-actor"
Extension.Slices for extension.extension:ig-actor.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:ig-option 0..* Extension IG Option
Extension.Slices for extension.extension:ig-option.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ig-option.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:ig-option.url 1..1 uri "ig-option"
Extension.Slices for extension.extension:ig-option.value[x] 0..1 string Value of extension
Extension.url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-implementation-guide"

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.extension:ig-usecase.​value[x] Base extensible NDH endpoint Implementation Guide Value Set 📦2.0.0-current This IG

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Extension

Summary

Complex Extension: This extension enables NDH to declare implementation-guide compatibility for endpoints when standard connection-type coding does not fully describe behavior, using structured sub-extensions for IG URI, name, use case, version, actor, and options with extensible use-case binding to NdhImplementationGuideVS; it is used in Endpoint.

  • ig-uri: canonical: An Extension
  • ig-name: string: An Extension
  • ig-usecase: CodeableConcept: An Extension
  • ig-version: string: An Extension
  • ig-actor: string: An Extension
  • ig-option: string: An Extension

Maturity: 4

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension NDH Implementation Guide Supported
Extension.Slices for extension Content/Rules for all slices
Extension.Slices for extension.extension:ig-uri 0..1 Extension IG Publication URI
Extension.Slices for extension.extension:ig-uri.extension 0..0 Extension
Extension.Slices for extension.extension:ig-uri.url 1..1 uri "ig-uri"
Extension.Slices for extension.extension:ig-uri.value[x] 0..1 canonical() Value of extension
Extension.Slices for extension.extension:ig-name 0..1 Extension IG Name
Extension.Slices for extension.extension:ig-name.extension 0..0 Extension
Extension.Slices for extension.extension:ig-name.url 1..1 uri "ig-name"
Extension.Slices for extension.extension:ig-name.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:ig-usecase 0..* Extension IG Use Case
Extension.Slices for extension.extension:ig-usecase.extension 0..0 Extension
Extension.Slices for extension.extension:ig-usecase.url 1..1 uri "ig-usecase"
Extension.Slices for extension.extension:ig-usecase.value[x] 0..1 CodeableConcept Value of extension
Binding: NDH endpoint Implementation Guide Value Set (extensible)
Extension.Slices for extension.extension:ig-version 0..1 Extension IG Version
Extension.Slices for extension.extension:ig-version.extension 0..0 Extension
Extension.Slices for extension.extension:ig-version.url 1..1 uri "ig-version"
Extension.Slices for extension.extension:ig-version.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:ig-actor 0..* Extension IG Actor
Extension.Slices for extension.extension:ig-actor.extension 0..0 Extension
Extension.Slices for extension.extension:ig-actor.url 1..1 uri "ig-actor"
Extension.Slices for extension.extension:ig-actor.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:ig-option 0..* Extension IG Option
Extension.Slices for extension.extension:ig-option.extension 0..0 Extension
Extension.Slices for extension.extension:ig-option.url 1..1 uri "ig-option"
Extension.Slices for extension.extension:ig-option.value[x] 0..1 string Value of extension
Extension.url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-implementation-guide"
Extension.value[x] 0..0 Value of extension

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Extension.extension:ig-usecase.​value[x] Base extensible NDH endpoint Implementation Guide Value Set 📦2.0.0-current This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension NDH Implementation Guide Supported
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:ig-uri 0..1 Extension IG Publication URI
Extension.Slices for extension.extension:ig-uri.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ig-uri.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:ig-uri.url 1..1 uri "ig-uri"
Extension.Slices for extension.extension:ig-uri.value[x] 0..1 canonical() Value of extension
Extension.Slices for extension.extension:ig-name 0..1 Extension IG Name
Extension.Slices for extension.extension:ig-name.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ig-name.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:ig-name.url 1..1 uri "ig-name"
Extension.Slices for extension.extension:ig-name.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:ig-usecase 0..* Extension IG Use Case
Extension.Slices for extension.extension:ig-usecase.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ig-usecase.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:ig-usecase.url 1..1 uri "ig-usecase"
Extension.Slices for extension.extension:ig-usecase.value[x] 0..1 CodeableConcept Value of extension
Binding: NDH endpoint Implementation Guide Value Set (extensible)
Extension.Slices for extension.extension:ig-version 0..1 Extension IG Version
Extension.Slices for extension.extension:ig-version.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ig-version.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:ig-version.url 1..1 uri "ig-version"
Extension.Slices for extension.extension:ig-version.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:ig-actor 0..* Extension IG Actor
Extension.Slices for extension.extension:ig-actor.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ig-actor.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:ig-actor.url 1..1 uri "ig-actor"
Extension.Slices for extension.extension:ig-actor.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:ig-option 0..* Extension IG Option
Extension.Slices for extension.extension:ig-option.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ig-option.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:ig-option.url 1..1 uri "ig-option"
Extension.Slices for extension.extension:ig-option.value[x] 0..1 string Value of extension
Extension.url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-implementation-guide"

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.extension:ig-usecase.​value[x] Base extensible NDH endpoint Implementation Guide Value Set 📦2.0.0-current This IG

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Extension

Summary

Complex Extension: This extension enables NDH to declare implementation-guide compatibility for endpoints when standard connection-type coding does not fully describe behavior, using structured sub-extensions for IG URI, name, use case, version, actor, and options with extensible use-case binding to NdhImplementationGuideVS; it is used in Endpoint.

  • ig-uri: canonical: An Extension
  • ig-name: string: An Extension
  • ig-usecase: CodeableConcept: An Extension
  • ig-version: string: An Extension
  • ig-actor: string: An Extension
  • ig-option: string: An Extension

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron