NDH HealthcareService or Program Requirement - National Directory of Healthcare Providers & Services (NDH) Implementation Guide v2.0.0

National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0 - draft 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 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 HealthcareService or Program Requirement

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement				Version: 2.0.0
Standards status: Trial-use				Computable Name: ServiceOrProgramRequirement

Service or Program requirement indicates whether the program is available to anyone, or only to those meeting certain criteria.

Context of Use

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

Element ID: HealthcareService

Usage info

Usages:

Use this Extension: NDH HealthcareService Profile
Examples for this Extension: HOPE INC, Towson Food INC and Welcome Home

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

Differential Table
Snapshot Table
Statistics/References
All

This structure is derived from Extension

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Extension	C	0..*	Extension	NDH HealthcareService or Program Requirement Constraints: agerange-or-agegroup
Slices for extension				Content/Rules for all slices
extension:age-range		0..1	Range	Age Range URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-range
extension:age-group		0..1	CodeableConcept	Age Group URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-group Binding: Age Range Value Set (extensible)
extension:birthsex		0..1	Extension	Birth Sex
extension		0..0
url		1..1	uri	"birthsex"
value[x]		1..1	code	Value of extension Binding: BirthSex (6.1.0) (required)
extension:employment-status		0..1	Extension	Employment Status
extension		0..0
url		1..1	uri	"employment-status"
value[x]		1..1	CodeableConcept	Value of extension Binding: Employment Status Value Set (extensible)
extension:insurance-status		0..1	Extension	Insurance Status
extension		0..0
url		1..1	uri	"insurance-status"
value[x]		1..1	CodeableConcept	Value of extension Binding: Insurance Status Value Set (extensible)
extension:va-status		0..1	Extension	Veteran Status
extension		0..0
url		1..1	uri	"va-status"
value[x]		1..1	boolean	Value of extension
extension:preferred-language		0..1	Extension	Extension
extension		0..0
url		1..1	uri	"preferred-language"
value[x]		0..1	CodeableConcept	Value of extension Binding: CommonLanguages (extensible)
url		1..1	uri	"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement"
value[x]		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Extension	C	0..*	Extension	NDH HealthcareService or Program Requirement Constraints: agerange-or-agegroup
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:age-range		0..1	Range	Age Range URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-range
extension:age-group		0..1	CodeableConcept	Age Group URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-group Binding: Age Range Value Set (extensible)
extension:birthsex		0..1	Extension	Birth Sex
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"birthsex"
value[x]		1..1	code	Value of extension Binding: BirthSex (6.1.0) (required)
extension:employment-status		0..1	Extension	Employment Status
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"employment-status"
value[x]		1..1	CodeableConcept	Value of extension Binding: Employment Status Value Set (extensible)
extension:insurance-status		0..1	Extension	Insurance Status
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"insurance-status"
value[x]		1..1	CodeableConcept	Value of extension Binding: Insurance Status Value Set (extensible)
extension:va-status		0..1	Extension	Veteran Status
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"va-status"
value[x]		1..1	boolean	Value of extension
extension:preferred-language		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"preferred-language"
value[x]		0..1	CodeableConcept	Value of extension Binding: CommonLanguages (extensible)
url		1..1	uri	"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement"
Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Service or Program requirement indicates whether the program is available to anyone, or only to those meeting certain criteria.

birthsex: code: An Extension
employment-status: CodeableConcept: An Extension
insurance-status: CodeableConcept: An Extension
va-status: boolean: An Extension
preferred-language: CodeableConcept: An Extension

Differential View

This structure is derived from Extension

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Extension	C	0..*	Extension	NDH HealthcareService or Program Requirement Constraints: agerange-or-agegroup
Slices for extension				Content/Rules for all slices
extension:age-range		0..1	Range	Age Range URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-range
extension:age-group		0..1	CodeableConcept	Age Group URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-group Binding: Age Range Value Set (extensible)
extension:birthsex		0..1	Extension	Birth Sex
extension		0..0
url		1..1	uri	"birthsex"
value[x]		1..1	code	Value of extension Binding: BirthSex (6.1.0) (required)
extension:employment-status		0..1	Extension	Employment Status
extension		0..0
url		1..1	uri	"employment-status"
value[x]		1..1	CodeableConcept	Value of extension Binding: Employment Status Value Set (extensible)
extension:insurance-status		0..1	Extension	Insurance Status
extension		0..0
url		1..1	uri	"insurance-status"
value[x]		1..1	CodeableConcept	Value of extension Binding: Insurance Status Value Set (extensible)
extension:va-status		0..1	Extension	Veteran Status
extension		0..0
url		1..1	uri	"va-status"
value[x]		1..1	boolean	Value of extension
extension:preferred-language		0..1	Extension	Extension
extension		0..0
url		1..1	uri	"preferred-language"
value[x]		0..1	CodeableConcept	Value of extension Binding: CommonLanguages (extensible)
url		1..1	uri	"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement"
value[x]		0..0
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Extension	C	0..*	Extension	NDH HealthcareService or Program Requirement Constraints: agerange-or-agegroup
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:age-range		0..1	Range	Age Range URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-range
extension:age-group		0..1	CodeableConcept	Age Group URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-group Binding: Age Range Value Set (extensible)
extension:birthsex		0..1	Extension	Birth Sex
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"birthsex"
value[x]		1..1	code	Value of extension Binding: BirthSex (6.1.0) (required)
extension:employment-status		0..1	Extension	Employment Status
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"employment-status"
value[x]		1..1	CodeableConcept	Value of extension Binding: Employment Status Value Set (extensible)
extension:insurance-status		0..1	Extension	Insurance Status
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"insurance-status"
value[x]		1..1	CodeableConcept	Value of extension Binding: Insurance Status Value Set (extensible)
extension:va-status		0..1	Extension	Veteran Status
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"va-status"
value[x]		1..1	boolean	Value of extension
extension:preferred-language		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"preferred-language"
value[x]		0..1	CodeableConcept	Value of extension Binding: CommonLanguages (extensible)
url		1..1	uri	"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement"
Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Service or Program requirement indicates whether the program is available to anyone, or only to those meeting certain criteria.

birthsex: code: An Extension
employment-status: CodeableConcept: An Extension
insurance-status: CodeableConcept: An Extension
va-status: boolean: An Extension
preferred-language: CodeableConcept: An Extension

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Extension.extension:birthsex.value[x]	Base	required	Birth Sex	📍6.1.0	US Core v6.1
Extension.extension:employment-status.value[x]	Base	extensible	Employment Status Value Set	📦2.0.0	This IG
Extension.extension:insurance-status.value[x]	Base	extensible	Insurance Status Value Set	📦2.0.0	This IG
Extension.extension:preferred-language.value[x]	Base	extensible	Common Languages	📦4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
agerange-or-agegroup	error	Extension	a service or program only allow to have either age-range or age-group but not both	`extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-range').empty() or extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-group').empty() or (extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-range').empty() and extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-group').empty())`
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-10-16
Links: Table of Contents | QA Report | Version History | | Propose a change