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 New Patients

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

New Patients indicates whether new patients are being accepted in general, or from a specific network.
This extension is included in the PractitionerRole, HealthcareService, and Location profiles.
This provides needed flexibility for specifying whether a provider accepts new patients by location and network.

Context of Use

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 C 0..* Extension NDH New Patients
Constraints: new-patients-characteristics
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:acceptingPatients S 1..1 Extension Accepting Patients
..... extension 0..0 Extension
..... url 1..1 uri "acceptingPatients"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Accepting Patients Codes Value Set (required)
.... extension:fromNetwork S 0..1 Extension From Network
..... extension 0..0 Extension
..... url 1..1 uri "fromNetwork"
..... value[x] 1..1 Reference(NDH Network Profile) Value of extension
.... extension:characteristics S 0..* string Characteristics of accepted patients
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients-characteristics
... url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients"

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Extension.extension:acceptingPatients.​value[x] Base required Accepting Patients Codes Value Set 📦2.0.0-current This IG

Constraints

Id Grade Path(s) Description Expression
new-patients-characteristics error Extension If no new patients are accepted, no characteristics are allowed extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients').value.coding.exists(code = 'nopt') implies extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients-characteristics').empty()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension C 0..* Extension NDH New Patients
Constraints: new-patients-characteristics
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:acceptingPatients S 1..1 Extension Accepting Patients
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "acceptingPatients"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Accepting Patients Codes Value Set (required)
.... extension:fromNetwork S 0..1 Extension From Network
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "fromNetwork"
..... value[x] 1..1 Reference(NDH Network Profile) Value of extension
.... extension:characteristics S 0..* string Characteristics of accepted patients
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients-characteristics
... url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients"

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.extension:acceptingPatients.​value[x] Base required Accepting Patients Codes 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()
new-patients-characteristics error Extension If no new patients are accepted, no characteristics are allowed extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients').value.coding.exists(code = 'nopt') implies extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients-characteristics').empty()

Summary

Complex Extension: New Patients indicates whether new patients are being accepted in general, or from a specific network.
This extension is included in the PractitionerRole, HealthcareService, and Location profiles.
This provides needed flexibility for specifying whether a provider accepts new patients by location and network.

  • acceptingPatients: CodeableConcept: An Extension
  • fromNetwork: Reference: An Extension

Maturity: 4

Differential ViewDifferential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension C 0..* Extension NDH New Patients
Constraints: new-patients-characteristics
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:acceptingPatients S 1..1 Extension Accepting Patients
..... extension 0..0 Extension
..... url 1..1 uri "acceptingPatients"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Accepting Patients Codes Value Set (required)
.... extension:fromNetwork S 0..1 Extension From Network
..... extension 0..0 Extension
..... url 1..1 uri "fromNetwork"
..... value[x] 1..1 Reference(NDH Network Profile) Value of extension
.... extension:characteristics S 0..* string Characteristics of accepted patients
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients-characteristics
... url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients"

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Extension.extension:acceptingPatients.​value[x] Base required Accepting Patients Codes Value Set 📦2.0.0-current This IG

Constraints

Id Grade Path(s) Description Expression
new-patients-characteristics error Extension If no new patients are accepted, no characteristics are allowed extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients').value.coding.exists(code = 'nopt') implies extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients-characteristics').empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension C 0..* Extension NDH New Patients
Constraints: new-patients-characteristics
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:acceptingPatients S 1..1 Extension Accepting Patients
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "acceptingPatients"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Accepting Patients Codes Value Set (required)
.... extension:fromNetwork S 0..1 Extension From Network
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "fromNetwork"
..... value[x] 1..1 Reference(NDH Network Profile) Value of extension
.... extension:characteristics S 0..* string Characteristics of accepted patients
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients-characteristics
... url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients"

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.extension:acceptingPatients.​value[x] Base required Accepting Patients Codes 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()
new-patients-characteristics error Extension If no new patients are accepted, no characteristics are allowed extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients').value.coding.exists(code = 'nopt') implies extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients-characteristics').empty()

Summary

Complex Extension: New Patients indicates whether new patients are being accepted in general, or from a specific network.
This extension is included in the PractitionerRole, HealthcareService, and Location profiles.
This provides needed flexibility for specifying whether a provider accepts new patients by location and network.

  • acceptingPatients: CodeableConcept: An Extension
  • fromNetwork: Reference: An Extension

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron