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 Required Document

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument Version: 2.0.0-current
Standards status: Trial-use Active as of 2026-04-22 Maturity Level: 4 Computable Name: RequiredDocument

Documents that are required in order to access or use services (eg. Gov't issued ID, passport)

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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension NDH Required Document
... extension 2..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:requiredDocumentId 1..* Extension Extension
..... extension 0..0 Extension
..... url 1..1 uri "requiredDocumentId"
..... value[x] 0..1 string Value of extension
.... extension:document 1..* Extension Extension
..... extension 0..0 Extension
..... url 1..1 uri "document"
..... value[x] 0..1 string Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension NDH Required Document
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:requiredDocumentId 1..* Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "requiredDocumentId"
..... value[x] 0..1 string Value of extension
.... extension:document 1..* Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "document"
..... value[x] 0..1 string Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument"

doco Documentation for this format

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: Documents that are required in order to access or use services (eg. Gov't issued ID, passport)

  • requiredDocumentId: string: An Extension
  • document: string: An Extension

Maturity: 4

Differential ViewDifferential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension NDH Required Document
... extension 2..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:requiredDocumentId 1..* Extension Extension
..... extension 0..0 Extension
..... url 1..1 uri "requiredDocumentId"
..... value[x] 0..1 string Value of extension
.... extension:document 1..* Extension Extension
..... extension 0..0 Extension
..... url 1..1 uri "document"
..... value[x] 0..1 string Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension NDH Required Document
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:requiredDocumentId 1..* Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "requiredDocumentId"
..... value[x] 0..1 string Value of extension
.... extension:document 1..* Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "document"
..... value[x] 0..1 string Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument"

doco Documentation for this format

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: Documents that are required in order to access or use services (eg. Gov't issued ID, passport)

  • requiredDocumentId: string: An Extension
  • document: string: An Extension

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron