National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0 - draft
National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0 - draft
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/base-ext-endpoint-usecase | Version: 2.0.0 | |||
| Standards status: Trial-use | Computable Name: EndpointUsecase | |||
EndpointUseCase is an enumeration of the specific use cases (service descriptions) supported by the endpoint
Context of Use
This extension may be used on the following element(s)
Endpoint
Usage info
Usages:
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Extension |
0..* | Extension | NDH Endpoint Usecase | |
  extension |
1..* | Extension | Extension | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:endpointUsecasetype |
S | 1..1 | Extension | An indication of the type of services supported by the endpoint |
  extension |
0..0 | |||
| url |
1..1 | uri | "endpointUsecasetype" | |
  value[x] |
1..1 | CodeableConcept | Value of extension Binding: NDH FHIR Endpoint Usecase Value Set (extensible) | |
 extension:standard |
S | 0..1 | Extension | A URI to a published standard describing the services supported by the endpoint (e.g. an HL7 implementation guide) |
 extension |
0..0 | |||
| url |
1..1 | uri | "standard" | |
 value[x] |
1..1 | uri | Value of extension | |
| url |
1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-usecase" | |
 value[x] |
0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | NDH Endpoint Usecase | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:endpointUsecasetype |
S | 1..1 | Extension | An indication of the type of services supported by the endpoint |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "endpointUsecasetype" | |
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: NDH FHIR Endpoint Usecase Value Set (extensible) | |
| extension:standard |
S | 0..1 | Extension | A URI to a published standard describing the services supported by the endpoint (e.g. an HL7 implementation guide) |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "standard" | |
| value[x] |
1..1 | uri | Value of extension | |
| url |
1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-usecase" | |
| Documentation for this format | ||||
This structure is derived from Extension
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | NDH Endpoint Usecase | |
| extension |
1..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:endpointUsecasetype |
S | 1..1 | Extension | An indication of the type of services supported by the endpoint |
| extension |
0..0 | |||
| url |
1..1 | uri | "endpointUsecasetype" | |
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: NDH FHIR Endpoint Usecase Value Set (extensible) | |
| extension:standard |
S | 0..1 | Extension | A URI to a published standard describing the services supported by the endpoint (e.g. an HL7 implementation guide) |
| extension |
0..0 | |||
| url |
1..1 | uri | "standard" | |
| value[x] |
1..1 | uri | Value of extension | |
| url |
1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-usecase" | |
| value[x] |
0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | NDH Endpoint Usecase | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:endpointUsecasetype |
S | 1..1 | Extension | An indication of the type of services supported by the endpoint |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "endpointUsecasetype" | |
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: NDH FHIR Endpoint Usecase Value Set (extensible) | |
| extension:standard |
S | 0..1 | Extension | A URI to a published standard describing the services supported by the endpoint (e.g. an HL7 implementation guide) |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "standard" | |
| value[x] |
1..1 | uri | Value of extension | |
| url |
1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-usecase" | |
| Documentation for this format | ||||
This structure is derived from Extension
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet | URI |
| Extension.extension:endpointUsecasetype.value[x] | extensible | NdhFhirEndpointUseCaseVS(a valid code from NDH FHIR Endpoint Use Case Code System)http://hl7.org/fhir/us/ndh/ValueSet/NdhFhirEndpointUseCaseVSFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
IG © 2023+ HL7 International / Patient Administration. Package hl7.fhir.us.ndh#2.0.0 based on FHIR 4.0.1. Generated 2025-07-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change