National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot 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 1.0.0-ballot 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: 1.0.0-ballot
Active as of 2024-06-17 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

Usage:

Formal Views of Extension Content

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

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
  • gender-identity: CodeableConcept: An Extension
  • employment-status: CodeableConcept: An Extension
  • insurance-status: CodeableConcept: An Extension
  • va-status: boolean: An Extension
  • preferred-language: CodeableConcept: An Extension

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension C 0..* Extension NDH HealthcareService or Program Requirement
agerange-or-agegroup: a service or program only allow to have either age-range or age-group but not both
... Slices for extension Content/Rules for all slices
.... age-range 0..1 Range Age Range
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-range
.... 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: Birth Sex (required)
.... extension:gender-identity 0..1 Extension Gender Identity
..... extension 0..0
..... url 1..1 uri "gender-identity"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Gender Identity . (extensible)
.... 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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension C 0..* Extension NDH HealthcareService or Program Requirement
agerange-or-agegroup: a service or program only allow to have either age-range or age-group but not both
... 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
.... age-range 0..1 Range Age Range
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-range
.... 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: Birth Sex (required)
.... extension:gender-identity 0..1 Extension Gender Identity
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "gender-identity"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Gender Identity . (extensible)
.... 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"

doco 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
  • gender-identity: CodeableConcept: 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension C 0..* Extension NDH HealthcareService or Program Requirement
agerange-or-agegroup: a service or program only allow to have either age-range or age-group but not both
... Slices for extension Content/Rules for all slices
.... age-range 0..1 Range Age Range
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-range
.... 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: Birth Sex (required)
.... extension:gender-identity 0..1 Extension Gender Identity
..... extension 0..0
..... url 1..1 uri "gender-identity"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Gender Identity . (extensible)
.... 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

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension C 0..* Extension NDH HealthcareService or Program Requirement
agerange-or-agegroup: a service or program only allow to have either age-range or age-group but not both
... 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
.... age-range 0..1 Range Age Range
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-range
.... 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: Birth Sex (required)
.... extension:gender-identity 0..1 Extension Gender Identity
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "gender-identity"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Gender Identity . (extensible)
.... 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"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:birthsex.value[x]requiredBirthSex
http://hl7.org/fhir/us/core/ValueSet/birthsex
Extension.extension:gender-identity.value[x]extensibleGenderIdentity .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32
Extension.extension:employment-status.value[x]extensibleEmploymentStatusVS
http://hl7.org/fhir/us/ndh/ValueSet/EmploymentStatusVS
from this IG
Extension.extension:insurance-status.value[x]extensibleInsuranceStatusVS (a valid code from Insurance Status Code System)
http://hl7.org/fhir/us/ndh/ValueSet/InsuranceStatusVS
from this IG
Extension.extension:preferred-language.value[x]extensibleCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
agerange-or-agegrouperrorExtensiona 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())