NDH Organization Profile - National Directory of Healthcare Providers & Services (NDH) Implementation Guide v2.0.0-current

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

Resource Profile: NDH Organization Profile

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization	Version: 2.0.0-current	Highlight text changes?
Standards status: Trial-use	Maturity Level: 4	Computable Name: NdhOrganization
Other Identifiers: OID:2.16.840.1.113883.4.642.40.43.42.46

This profile enables NDH to publish authoritative organizational identities, attributes, and contact channels so directory consumers can verify entities, understand what they offer, and connect organizations to plans, networks, services, and exchange endpoints; it adds extensions for ratings, funding, accepted payments, organization description, insurance-plan linkage, CMS-alignment indicators, verification, logos, and alias metadata, and applies ValueSet constraints for organization type and state/address semantics.

Boundraries and Relationships

The Organization resource is commonly structured as a hierarchy of organization resources, where the part-of property is used to indicate the relationship between child and parent organizations. This hierarchy serves to convey the conceptual structure of the organization. Organization has following key attributes:

A unique logical identifier that identifies the organization as an entity.
The name of the organization as known to humans.
Telecommunication identifiers that can be used to reach the organization.
Information about any large organizations that the organization might be part of.
One or more endpoints for electronic communication and data exchange.

Note: The NDH Organization and Network profiles are both based on the Organization profile. To selectively query only Network profiles, search for type = 'ntwk'. To selectively query only Organization profiles, the type parameter is optional. However, you can provide any value defined in the Organization Type Value Set.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

Key Elements Table
Differential Table
Snapshot Table
Statistics/References
All

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Organization	C	0..*	USCoreOrganizationProfile(6.1.0)	A grouping of people or organizations with a common purpose Constraints: org-1
Organization.implicitRules	This element is a modifier element. This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Organization.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for extension.extension:rating		0..*	(Complex)	NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
Organization.Slices for extension.extension:paymentaccepted		0..*	CodeableConcept	NDH Payment Accepted URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: Hl7VSPaymentMethodCode (2.0.0) (required)
Organization.Slices for extension.extension:fundingSource		0..*	(Complex)	NDH Funding Source URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
Organization.Slices for extension.extension:org-description		0..1	string	Organization Description URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-description
Organization.Slices for extension.extension:insuranceplan		0..*	Reference(NDH InsurancePlan Profile)	Insurance plan(s) offered to the organization's employees URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-insuranceplan-reference
Organization.Slices for extension.extension:cms-medicare-enrollment-in-good-standing		0..1	boolean	CMS Enrollment In Good Standing URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-medicare-enrollment-in-good-standing
Organization.Slices for extension.extension:cms-identity-verified		0..1	boolean	CMS Identity Verified URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-identity-verified
Organization.Slices for extension.extension:cms-aligned-with-data-network		0..1	boolean	Aligned with CMS Data Network URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-aligned-with-data-network
Organization.Slices for extension.extension:hhs-exclusion-list		0..1	boolean	HHS Exclusion List URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-hhs-exclusion-list
Organization.Slices for extension.extension:verification-status		0..1	CodeableConcept	NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible)
Organization.Slices for extension.extension:logo		0..1	Attachment	NDH Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
Organization.modifierExtension	This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Organization.Slices for identifier	This element must be supported. This element is included in summaries. C	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this, value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:All Slices				Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.Slices for extension				Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.Slices for extension.extension:identifier-status		0..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
Organization.Slices for identifier.identifier:All Slices.use	This element is a modifier element. This element is included in summaries.	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:All Slices.system	This element must be supported. This element is included in summaries.	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Organization.Slices for identifier.identifier:All Slices.value	This element must be supported. This element is included in summaries.	0..1	string	The value that is unique Example General: 123456
Organization.Slices for identifier.identifier:All Slices.assigner	This element is included in summaries.	0..1	Reference(NDH Organization Profile)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:NPI	This element must be supported. This element is included in summaries. C	0..*	Identifier	National Provider Identifier (NPI) Constraints: us-core-16, us-core-17 Required Pattern: `{ "system" : "http://hl7.org/fhir/sid/us-npi" }`
Organization.Slices for identifier.identifier:CLIA	This element is included in summaries. C	0..*	Identifier	Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Constraints: us-core-18 Required Pattern: `{ "system" : "urn:oid:2.16.840.1.113883.4.7" }`
Organization.Slices for identifier.identifier:NAIC	This element is included in summaries. C	0..*	Identifier	NAIC Code Constraints: us-core-19 Required Pattern: `{ "system" : "urn:oid:2.16.840.1.113883.6.300" }`
Organization.Slices for identifier.identifier:TID	This element is included in summaries. C	0..1	Identifier	Tax Identifier Required Pattern: `{ "system" : "http://hl7.org/fhir/sid/us-ssn" }`
Organization.Slices for identifier.identifier:PIN	This element is included in summaries. C	0..*	Identifier	Payer Identification Number
Organization.Slices for identifier.identifier:PIN.Slices for extension				Content/Rules for all slices
Organization.Slices for identifier.identifier:PIN.Slices for extension.extension:identifier-status		0..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
Organization.Slices for identifier.identifier:PIN.use	This element is a modifier element. This element is included in summaries.	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:PIN.type	This element is included in summaries.	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "PAYERID" } ] }`
Organization.Slices for identifier.identifier:PIN.system	This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Organization.Slices for identifier.identifier:PIN.value	This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Organization.active	This element is a modifier element. This element must be supported. This element is included in summaries.	1..1	boolean	Whether the organization's record is still in active use Required Pattern: true (extensions allowed)
Organization.type	This element must be supported. This element is included in summaries.	1..*	CodeableConcept	Kind of organization Binding: Organization Type Value Set (extensible)
Organization.name	This element must be supported. This element is included in summaries. C	1..1	string	Name used for the organization
Organization.alias	This element must be supported.	0..*	string	A list of alternate names that the organization is known as, or was known as in the past
Organization.alias.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.alias.Slices for extension.extension:org-alias-type		0..1	CodeableConcept	Organization Alias Type URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-type Binding: Organization Alias Type Value Sete (example)
Organization.alias.Slices for extension.extension:org-alias-period		0..1	Period	Organization Alias Period URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-period
Organization.telecom	This element must be supported. C	0..*	ContactPoint	A contact detail for the organization Constraints: org-3
Organization.telecom.Slices for extension				Content/Rules for all slices
Organization.telecom.Slices for extension.extension:language-speak		0..*	code	Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible)
Organization.telecom.system	This element must be supported. This element is included in summaries. C	0..1	code	phone \| fax \| email \| pager \| url \| sms \| other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Organization.telecom.value	This element must be supported. This element is included in summaries.	0..1	string	The actual contact point details
Organization.telecom.use	This element is a modifier element. This element is included in summaries.	0..1	code	home \| work \| temp \| old \| mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Organization.address	This element must be supported. C	0..*	Address	An address for the organization Constraints: org-2
Organization.address.Slices for extension				Content/Rules for all slices
Organization.address.Slices for extension.extension:geolocation		0..1	(Complex)	The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation
Organization.address.use	This element is a modifier element. This element is included in summaries.	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Organization.address.line	This element must be supported. This element is included in summaries.	0..4	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
Organization.address.city	This element must be supported. This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon
Organization.address.state	This element must be supported. This element is included in summaries.	0..1	string	Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
Organization.address.postalCode	This element must be supported. This element is included in summaries.	0..1	string	US Zip Codes Example General: 9132
Organization.address.country	This element must be supported. This element is included in summaries.	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Organization.partOf	This element is included in summaries.	0..1	Reference(NDH Organization Profile)	The organization of which this organization forms a part
Organization.endpoint	This element must be supported.	0..*	Reference(NDH Endpoint Profile)	Technical endpoints providing access to services operated for the organization
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Organization.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:PIN.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:PIN.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Organization.type	Base	extensible	Organization Type Value Set	📦2.0.0-current	This IG
Organization.telecom.system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Organization.telecom.use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Organization.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Organization.address.state	Base	extensible	USPS Two Letter Alphabetic Codes	📍6.1.0	US Core v6.1

Constraints

Id	Grade	Path(s)	Description	Expression
us-core-16	error	Organization.identifier:NPI	NPI must be 10 digits	`value.matches('^[0-9]{10}$')`
us-core-17	error	Organization.identifier:NPI	NPI check digit must be valid (Luhn algorithm check)	(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)
us-core-18	error	Organization.identifier:CLIA	CLIA number must be 10 digits with a letter "D" in third position	`value.matches('^[0-9]{2}D[0-9]{7}$')`
us-core-19	error	Organization.identifier:NAIC	NAIC must be 5 digits	`value.matches('^[0-9]{5}$')`

This structure is derived from USCoreOrganizationProfile

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Organization		0..*	USCoreOrganizationProfile(6.1.0)	A grouping of people or organizations with a common purpose
Organization.meta
Organization.meta.lastUpdated		1..1	instant	When the resource version last changed
Organization.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for extension.extension:rating		0..*	(Complex)	NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
Organization.Slices for extension.extension:paymentaccepted		0..*	CodeableConcept	NDH Payment Accepted URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: Hl7VSPaymentMethodCode (2.0.0) (required)
Organization.Slices for extension.extension:fundingSource		0..*	(Complex)	NDH Funding Source URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
Organization.Slices for extension.extension:org-description		0..1	string	Organization Description URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-description
Organization.Slices for extension.extension:insuranceplan		0..*	Reference(NDH InsurancePlan Profile)	Insurance plan(s) offered to the organization's employees URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-insuranceplan-reference
Organization.Slices for extension.extension:cms-medicare-enrollment-in-good-standing		0..1	boolean	CMS Enrollment In Good Standing URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-medicare-enrollment-in-good-standing
Organization.Slices for extension.extension:cms-identity-verified		0..1	boolean	CMS Identity Verified URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-identity-verified
Organization.Slices for extension.extension:cms-aligned-with-data-network		0..1	boolean	Aligned with CMS Data Network URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-aligned-with-data-network
Organization.Slices for extension.extension:hhs-exclusion-list		0..1	boolean	HHS Exclusion List URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-hhs-exclusion-list
Organization.Slices for extension.extension:verification-status		0..1	CodeableConcept	NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible)
Organization.Slices for extension.extension:logo		0..1	Attachment	NDH Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
Organization.Slices for identifier		0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this, value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:All Slices				Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.Slices for extension				Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.Slices for extension.extension:identifier-status		0..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
Organization.Slices for identifier.identifier:All Slices.assigner		0..1	Reference(NDH Organization Profile)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:TID		0..1	Identifier	Tax Identifier Required Pattern: `{ "system" : "http://hl7.org/fhir/sid/us-ssn" }`
Organization.Slices for identifier.identifier:PIN		0..*	Identifier	Payer Identification Number
Organization.Slices for identifier.identifier:PIN.Slices for extension				Content/Rules for all slices
Organization.Slices for identifier.identifier:PIN.Slices for extension.extension:identifier-status		0..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
Organization.Slices for identifier.identifier:PIN.type		1..1	CodeableConcept	Description of identifier Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "PAYERID" } ] }`
Organization.Slices for identifier.identifier:PIN.system		1..1	uri	The namespace for the identifier value
Organization.Slices for identifier.identifier:PIN.value		1..1	string	The value that is unique
Organization.active		1..1	boolean	Whether the organization's record is still in active use Required Pattern: true (extensions allowed)
Organization.type	This element must be supported.	1..*	CodeableConcept	Kind of organization Binding: Organization Type Value Set (extensible)
Organization.alias	This element must be supported.	0..*	string	A list of alternate names that the organization is known as, or was known as in the past
Organization.alias.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.alias.Slices for extension.extension:org-alias-type		0..1	CodeableConcept	Organization Alias Type URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-type Binding: Organization Alias Type Value Sete (example)
Organization.alias.Slices for extension.extension:org-alias-period		0..1	Period	Organization Alias Period URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-period
Organization.telecom		0..*	ContactPoint	A contact detail for the organization
Organization.telecom.Slices for extension				Content/Rules for all slices
Organization.telecom.Slices for extension.extension:language-speak		0..*	code	Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible)
Organization.address
Organization.address.Slices for extension				Content/Rules for all slices
Organization.address.Slices for extension.extension:geolocation		0..1	(Complex)	The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation
Organization.address.state		0..1	string	Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
Organization.partOf		0..1	Reference(NDH Organization Profile)	The organization of which this organization forms a part
Organization.endpoint	This element must be supported.	0..*	Reference(NDH Endpoint Profile)	Technical endpoints providing access to services operated for the organization
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Organization.type	Base	extensible	Organization Type Value Set	📦2.0.0-current	This IG
Organization.address.state	Base	extensible	USPS Two Letter Alphabetic Codes	📍6.1.0	US Core v6.1

Description & Constraints Filter:

Organization C 0..* USCoreOrganizationProfile(6.1.0) A grouping of people or organizations with a common purpose
Constraints: org-1

Organization.id This element is included in summaries. 0..1 id Logical id of this artifact

Organization.meta This element is included in summaries. 0..1 Meta Metadata about the resource

Organization.meta.id 0..1 string Unique id for inter-element referencing

Organization.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

Organization.meta.versionId This element is included in summaries. 0..1 id Version specific identifier

Organization.meta.lastUpdated This element is included in summaries. 1..1 instant When the resource version last changed

Organization.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from

Organization.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to

Organization.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.

Organization.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

Organization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created

language

0..1

code

Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional Bindings

Purpose

AllLanguages

Max Binding

Organization.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements

Organization.contained 0..* Resource Contained, inline Resources

Organization.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

Organization.Slices for extension.extension:rating 0..* (Complex) NDH Rating
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating

Organization.Slices for extension.extension:paymentaccepted 0..* CodeableConcept NDH Payment Accepted
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted
Binding: Hl7VSPaymentMethodCode (2.0.0) (required)

Organization.Slices for extension.extension:fundingSource 0..* (Complex) NDH Funding Source
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource

Organization.Slices for extension.extension:org-description 0..1 string Organization Description
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-description

Organization.Slices for extension.extension:insuranceplan 0..* Reference(NDH InsurancePlan Profile) Insurance plan(s) offered to the organization's employees
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-insuranceplan-reference

Organization.Slices for extension.extension:cms-medicare-enrollment-in-good-standing 0..1 boolean CMS Enrollment In Good Standing
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-medicare-enrollment-in-good-standing

Organization.Slices for extension.extension:cms-identity-verified 0..1 boolean CMS Identity Verified
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-identity-verified

Organization.Slices for extension.extension:cms-aligned-with-data-network 0..1 boolean Aligned with CMS Data Network
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-aligned-with-data-network

Organization.Slices for extension.extension:hhs-exclusion-list 0..1 boolean HHS Exclusion List
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-hhs-exclusion-list

Organization.Slices for extension.extension:verification-status 0..1 CodeableConcept NDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)

Organization.Slices for extension.extension:logo 0..1 Attachment NDH Logo
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo

Organization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored

Organization.Slices for identifier This element must be supported. This element is included in summaries. C 0..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this, value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

Organization.Slices for identifier.identifier:All Slices Content/Rules for all slices

Organization.Slices for identifier.identifier:All Slices.id 0..1 string Unique id for inter-element referencing

Organization.Slices for identifier.identifier:All Slices.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

Organization.Slices for identifier.identifier:All Slices.Slices for extension.extension:identifier-status 0..1 code NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)

Organization.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

Organization.Slices for identifier.identifier:All Slices.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Organization.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient

Organization.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 0..1 string The value that is unique
Example General: 123456

Organization.Slices for identifier.identifier:All Slices.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use

Organization.Slices for identifier.identifier:All Slices.assigner This element is included in summaries. 0..1 Reference(NDH Organization Profile) Organization that issued id (may be just text)

identifier:NPI

0..*

Identifier

National Provider Identifier (NPI)
Constraints: us-core-16, us-core-17

Required Pattern:

{
  "system" : "http://hl7.org/fhir/sid/us-npi"
}

identifier:CLIA

0..*

Identifier

Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
Constraints: us-core-18

Required Pattern:

{
  "system" : "urn:oid:2.16.840.1.113883.4.7"
}

identifier:NAIC

0..*

Identifier

NAIC Code
Constraints: us-core-19

Required Pattern:

{
  "system" : "urn:oid:2.16.840.1.113883.6.300"
}

identifier:TID

0..1

Identifier

Tax Identifier

Required Pattern:

{
  "system" : "http://hl7.org/fhir/sid/us-ssn"
}

Organization.Slices for identifier.identifier:PIN This element is included in summaries. C 0..* Identifier Payer Identification Number

Organization.Slices for identifier.identifier:PIN.id 0..1 string Unique id for inter-element referencing

Organization.Slices for identifier.identifier:PIN.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

Organization.Slices for identifier.identifier:PIN.Slices for extension Content/Rules for all slices

Organization.Slices for identifier.identifier:PIN.Slices for extension.extension:identifier-status 0..1 code NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)

Organization.Slices for identifier.identifier:PIN.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

type

1..1

CodeableConcept

Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern:

{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "PAYERID"
    }
  ]
}

Organization.Slices for identifier.identifier:PIN.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient

Organization.Slices for identifier.identifier:PIN.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456

Organization.Slices for identifier.identifier:PIN.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use

Organization.Slices for identifier.identifier:PIN.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)

Organization.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether the organization's record is still in active use
Required Pattern: true (extensions allowed)

Organization.type This element must be supported. This element is included in summaries. 1..* CodeableConcept Kind of organization
Binding: Organization Type Value Set (extensible)

Organization.name This element must be supported. This element is included in summaries. C 1..1 string Name used for the organization

Organization.alias This element must be supported. 0..* string A list of alternate names that the organization is known as, or was known as in the past

Organization.alias.id 0..1 string xml:id (or equivalent in JSON)

Organization.alias.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

Organization.alias.Slices for extension.extension:org-alias-type 0..1 CodeableConcept Organization Alias Type
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-type
Binding: Organization Alias Type Value Sete (example)

Organization.alias.Slices for extension.extension:org-alias-period 0..1 Period Organization Alias Period
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-period

Organization.alias.value 0..1 string Primitive value for string
Max Length:1048576

Organization.telecom This element must be supported. C 0..* ContactPoint A contact detail for the organization
Constraints: org-3

Organization.telecom.id 0..1 string Unique id for inter-element referencing

Organization.telecom.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

Organization.telecom.Slices for extension.extension:language-speak 0..* code Language Speak
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak
Binding: CommonLanguages (extensible)

Organization.telecom.system This element must be supported. This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

Organization.telecom.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details

Organization.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

Organization.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)

Organization.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use

Organization.address This element must be supported. C 0..* Address An address for the organization
Constraints: org-2

Organization.address.id 0..1 string Unique id for inter-element referencing

Organization.address.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

Organization.address.Slices for extension.extension:geolocation 0..1 (Complex) The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation

Organization.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home

Organization.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both

Organization.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132

Organization.address.line This element must be supported. This element is included in summaries. 0..4 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street

Organization.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon

Organization.address.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison

Organization.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)

Organization.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132

Organization.address.country This element must be supported. This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

Organization.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

Organization.partOf This element is included in summaries. 0..1 Reference(NDH Organization Profile) The organization of which this organization forms a part

Organization.contact 0..* BackboneElement Contact for the organization for a certain purpose

Organization.contact.id 0..1 string Unique id for inter-element referencing

Organization.contact.extension 0..* Extension Additional content defined by implementations

Organization.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

Organization.contact.purpose 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

Organization.contact.name 0..1 HumanName A name associated with the contact

Organization.contact.telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact

Organization.contact.address 0..1 Address Visiting or postal addresses for the contact

Organization.endpoint This element must be supported. 0..* Reference(NDH Endpoint Profile) Technical endpoints providing access to services operated for the organization

Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Organization.meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Organization.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
Organization.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Organization.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier.type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Organization.identifier:PIN.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:PIN.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Organization.type	Base	extensible	Organization Type Value Set	📦2.0.0-current	This IG
Organization.telecom.system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Organization.telecom.use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Organization.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Organization.address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Organization.address.state	Base	extensible	USPS Two Letter Alphabetic Codes	📍6.1.0	US Core v6.1
Organization.contact.purpose	Base	extensible	Contact entity type	📦4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
us-core-16	error	Organization.identifier:NPI	NPI must be 10 digits	`value.matches('^[0-9]{10}$')`
us-core-17	error	Organization.identifier:NPI	NPI check digit must be valid (Luhn algorithm check)	(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)
us-core-18	error	Organization.identifier:CLIA	CLIA number must be 10 digits with a letter "D" in third position	`value.matches('^[0-9]{2}D[0-9]{7}$')`
us-core-19	error	Organization.identifier:NAIC	NAIC must be 5 digits	`value.matches('^[0-9]{5}$')`

This structure is derived from USCoreOrganizationProfile

Summary

Mandatory: 1 element(4 nested mandatory elements)
Must-Support: 3 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

The element 2 is sliced based on the values of Organization.identifier

Maturity: 4

Key Elements View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Organization	C	0..*	USCoreOrganizationProfile(6.1.0)	A grouping of people or organizations with a common purpose Constraints: org-1
Organization.implicitRules	This element is a modifier element. This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Organization.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for extension.extension:rating		0..*	(Complex)	NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
Organization.Slices for extension.extension:paymentaccepted		0..*	CodeableConcept	NDH Payment Accepted URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: Hl7VSPaymentMethodCode (2.0.0) (required)
Organization.Slices for extension.extension:fundingSource		0..*	(Complex)	NDH Funding Source URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
Organization.Slices for extension.extension:org-description		0..1	string	Organization Description URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-description
Organization.Slices for extension.extension:insuranceplan		0..*	Reference(NDH InsurancePlan Profile)	Insurance plan(s) offered to the organization's employees URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-insuranceplan-reference
Organization.Slices for extension.extension:cms-medicare-enrollment-in-good-standing		0..1	boolean	CMS Enrollment In Good Standing URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-medicare-enrollment-in-good-standing
Organization.Slices for extension.extension:cms-identity-verified		0..1	boolean	CMS Identity Verified URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-identity-verified
Organization.Slices for extension.extension:cms-aligned-with-data-network		0..1	boolean	Aligned with CMS Data Network URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-aligned-with-data-network
Organization.Slices for extension.extension:hhs-exclusion-list		0..1	boolean	HHS Exclusion List URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-hhs-exclusion-list
Organization.Slices for extension.extension:verification-status		0..1	CodeableConcept	NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible)
Organization.Slices for extension.extension:logo		0..1	Attachment	NDH Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
Organization.modifierExtension	This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Organization.Slices for identifier	This element must be supported. This element is included in summaries. C	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this, value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:All Slices				Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.Slices for extension				Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.Slices for extension.extension:identifier-status		0..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
Organization.Slices for identifier.identifier:All Slices.use	This element is a modifier element. This element is included in summaries.	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:All Slices.system	This element must be supported. This element is included in summaries.	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Organization.Slices for identifier.identifier:All Slices.value	This element must be supported. This element is included in summaries.	0..1	string	The value that is unique Example General: 123456
Organization.Slices for identifier.identifier:All Slices.assigner	This element is included in summaries.	0..1	Reference(NDH Organization Profile)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:NPI	This element must be supported. This element is included in summaries. C	0..*	Identifier	National Provider Identifier (NPI) Constraints: us-core-16, us-core-17 Required Pattern: `{ "system" : "http://hl7.org/fhir/sid/us-npi" }`
Organization.Slices for identifier.identifier:CLIA	This element is included in summaries. C	0..*	Identifier	Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Constraints: us-core-18 Required Pattern: `{ "system" : "urn:oid:2.16.840.1.113883.4.7" }`
Organization.Slices for identifier.identifier:NAIC	This element is included in summaries. C	0..*	Identifier	NAIC Code Constraints: us-core-19 Required Pattern: `{ "system" : "urn:oid:2.16.840.1.113883.6.300" }`
Organization.Slices for identifier.identifier:TID	This element is included in summaries. C	0..1	Identifier	Tax Identifier Required Pattern: `{ "system" : "http://hl7.org/fhir/sid/us-ssn" }`
Organization.Slices for identifier.identifier:PIN	This element is included in summaries. C	0..*	Identifier	Payer Identification Number
Organization.Slices for identifier.identifier:PIN.Slices for extension				Content/Rules for all slices
Organization.Slices for identifier.identifier:PIN.Slices for extension.extension:identifier-status		0..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
Organization.Slices for identifier.identifier:PIN.use	This element is a modifier element. This element is included in summaries.	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:PIN.type	This element is included in summaries.	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "PAYERID" } ] }`
Organization.Slices for identifier.identifier:PIN.system	This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Organization.Slices for identifier.identifier:PIN.value	This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Organization.active	This element is a modifier element. This element must be supported. This element is included in summaries.	1..1	boolean	Whether the organization's record is still in active use Required Pattern: true (extensions allowed)
Organization.type	This element must be supported. This element is included in summaries.	1..*	CodeableConcept	Kind of organization Binding: Organization Type Value Set (extensible)
Organization.name	This element must be supported. This element is included in summaries. C	1..1	string	Name used for the organization
Organization.alias	This element must be supported.	0..*	string	A list of alternate names that the organization is known as, or was known as in the past
Organization.alias.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.alias.Slices for extension.extension:org-alias-type		0..1	CodeableConcept	Organization Alias Type URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-type Binding: Organization Alias Type Value Sete (example)
Organization.alias.Slices for extension.extension:org-alias-period		0..1	Period	Organization Alias Period URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-period
Organization.telecom	This element must be supported. C	0..*	ContactPoint	A contact detail for the organization Constraints: org-3
Organization.telecom.Slices for extension				Content/Rules for all slices
Organization.telecom.Slices for extension.extension:language-speak		0..*	code	Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible)
Organization.telecom.system	This element must be supported. This element is included in summaries. C	0..1	code	phone \| fax \| email \| pager \| url \| sms \| other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Organization.telecom.value	This element must be supported. This element is included in summaries.	0..1	string	The actual contact point details
Organization.telecom.use	This element is a modifier element. This element is included in summaries.	0..1	code	home \| work \| temp \| old \| mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Organization.address	This element must be supported. C	0..*	Address	An address for the organization Constraints: org-2
Organization.address.Slices for extension				Content/Rules for all slices
Organization.address.Slices for extension.extension:geolocation		0..1	(Complex)	The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation
Organization.address.use	This element is a modifier element. This element is included in summaries.	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Organization.address.line	This element must be supported. This element is included in summaries.	0..4	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
Organization.address.city	This element must be supported. This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon
Organization.address.state	This element must be supported. This element is included in summaries.	0..1	string	Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
Organization.address.postalCode	This element must be supported. This element is included in summaries.	0..1	string	US Zip Codes Example General: 9132
Organization.address.country	This element must be supported. This element is included in summaries.	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Organization.partOf	This element is included in summaries.	0..1	Reference(NDH Organization Profile)	The organization of which this organization forms a part
Organization.endpoint	This element must be supported.	0..*	Reference(NDH Endpoint Profile)	Technical endpoints providing access to services operated for the organization
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Organization.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:PIN.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:PIN.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Organization.type	Base	extensible	Organization Type Value Set	📦2.0.0-current	This IG
Organization.telecom.system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Organization.telecom.use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Organization.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Organization.address.state	Base	extensible	USPS Two Letter Alphabetic Codes	📍6.1.0	US Core v6.1

Constraints

Id	Grade	Path(s)	Description	Expression
us-core-16	error	Organization.identifier:NPI	NPI must be 10 digits	`value.matches('^[0-9]{10}$')`
us-core-17	error	Organization.identifier:NPI	NPI check digit must be valid (Luhn algorithm check)	(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)
us-core-18	error	Organization.identifier:CLIA	CLIA number must be 10 digits with a letter "D" in third position	`value.matches('^[0-9]{2}D[0-9]{7}$')`
us-core-19	error	Organization.identifier:NAIC	NAIC must be 5 digits	`value.matches('^[0-9]{5}$')`

Differential View

This structure is derived from USCoreOrganizationProfile

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Organization		0..*	USCoreOrganizationProfile(6.1.0)	A grouping of people or organizations with a common purpose
Organization.meta
Organization.meta.lastUpdated		1..1	instant	When the resource version last changed
Organization.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for extension.extension:rating		0..*	(Complex)	NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
Organization.Slices for extension.extension:paymentaccepted		0..*	CodeableConcept	NDH Payment Accepted URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: Hl7VSPaymentMethodCode (2.0.0) (required)
Organization.Slices for extension.extension:fundingSource		0..*	(Complex)	NDH Funding Source URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
Organization.Slices for extension.extension:org-description		0..1	string	Organization Description URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-description
Organization.Slices for extension.extension:insuranceplan		0..*	Reference(NDH InsurancePlan Profile)	Insurance plan(s) offered to the organization's employees URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-insuranceplan-reference
Organization.Slices for extension.extension:cms-medicare-enrollment-in-good-standing		0..1	boolean	CMS Enrollment In Good Standing URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-medicare-enrollment-in-good-standing
Organization.Slices for extension.extension:cms-identity-verified		0..1	boolean	CMS Identity Verified URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-identity-verified
Organization.Slices for extension.extension:cms-aligned-with-data-network		0..1	boolean	Aligned with CMS Data Network URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-aligned-with-data-network
Organization.Slices for extension.extension:hhs-exclusion-list		0..1	boolean	HHS Exclusion List URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-hhs-exclusion-list
Organization.Slices for extension.extension:verification-status		0..1	CodeableConcept	NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible)
Organization.Slices for extension.extension:logo		0..1	Attachment	NDH Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
Organization.Slices for identifier		0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this, value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:All Slices				Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.Slices for extension				Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.Slices for extension.extension:identifier-status		0..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
Organization.Slices for identifier.identifier:All Slices.assigner		0..1	Reference(NDH Organization Profile)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:TID		0..1	Identifier	Tax Identifier Required Pattern: `{ "system" : "http://hl7.org/fhir/sid/us-ssn" }`
Organization.Slices for identifier.identifier:PIN		0..*	Identifier	Payer Identification Number
Organization.Slices for identifier.identifier:PIN.Slices for extension				Content/Rules for all slices
Organization.Slices for identifier.identifier:PIN.Slices for extension.extension:identifier-status		0..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
Organization.Slices for identifier.identifier:PIN.type		1..1	CodeableConcept	Description of identifier Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "PAYERID" } ] }`
Organization.Slices for identifier.identifier:PIN.system		1..1	uri	The namespace for the identifier value
Organization.Slices for identifier.identifier:PIN.value		1..1	string	The value that is unique
Organization.active		1..1	boolean	Whether the organization's record is still in active use Required Pattern: true (extensions allowed)
Organization.type	This element must be supported.	1..*	CodeableConcept	Kind of organization Binding: Organization Type Value Set (extensible)
Organization.alias	This element must be supported.	0..*	string	A list of alternate names that the organization is known as, or was known as in the past
Organization.alias.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.alias.Slices for extension.extension:org-alias-type		0..1	CodeableConcept	Organization Alias Type URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-type Binding: Organization Alias Type Value Sete (example)
Organization.alias.Slices for extension.extension:org-alias-period		0..1	Period	Organization Alias Period URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-period
Organization.telecom		0..*	ContactPoint	A contact detail for the organization
Organization.telecom.Slices for extension				Content/Rules for all slices
Organization.telecom.Slices for extension.extension:language-speak		0..*	code	Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible)
Organization.address
Organization.address.Slices for extension				Content/Rules for all slices
Organization.address.Slices for extension.extension:geolocation		0..1	(Complex)	The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation
Organization.address.state		0..1	string	Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
Organization.partOf		0..1	Reference(NDH Organization Profile)	The organization of which this organization forms a part
Organization.endpoint	This element must be supported.	0..*	Reference(NDH Endpoint Profile)	Technical endpoints providing access to services operated for the organization
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Organization.type	Base	extensible	Organization Type Value Set	📦2.0.0-current	This IG
Organization.address.state	Base	extensible	USPS Two Letter Alphabetic Codes	📍6.1.0	US Core v6.1

Snapshot ViewView