National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0-current - ci-build

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
Standards status: Trial-use | Maturity Level: 4 | Computable Name: NdhOrganization

An organization is a formal or informal grouping of people or organizations with a common purpose, such as a company, institution, corporation, community group, or healthcare practice. Guidance: When the contact is a department name, rather than a human (e.g., patient help line), include a blank family and given name, and provide the department name in contact.name.text

### 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:

1. A unique logical identifier that identifies the organization as an entity.
2. The name of the organization as known to humans.
3. Telecommunication identifiers that can be used to reach the organization.
4. Information about any large organizations that the organization might be part of.
5. 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:

- Refer to this Profile: NDH Endpoint Testing Certification, NDH Funding Source, NDH Qualification, NDH Via Intermediary... Show 11 more, NDH Endpoint Profile, NDH Group, NDH HealthcareService Profile, NDH InsurancePlan Profile, NDH Location Profile, NDH Network Profile, NDH Organization Profile, NDH OrganizationAffiliation Profile, NDH Practitioner Profile, NDH PractitionerRole and NDH Verification
- Examples for this Profile: Acme of CT, Big Box Retailer, BlueCrossBlueShield CT Organization, Burr Clinic... Show 14 more, Hamilton Clinic, Hartford Orthopedics Services, Hartford General Hospital, Housing Assistance Hub Management, Organization Manage Payer Network (OMPN), OrgOneWithNetwork1AndNetwork2, Hope INC, Hope INC, OrganizationGen1, OrganizationGen2, StateMedicaidAgencyAlabama, Welcome Home, Pharm Chain and State of Illinois Licensing Board
- CapabilityStatements using this Profile: NDH Server Capability Statement

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

- 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
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:rating |  | 0..* | (Complex) | NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
extension:paymentaccepted |  | 0..* | CodeableConcept | NDH Payment Accepted URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: Hl7VSPaymentMethodCode (2.0.0) (required)
extension:fundingSource |  | 0..* | (Complex) | NDH Funding Source URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
extension:org-description |  | 0..1 | string | Organization Description URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-description
extension:qualification |  | 0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
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
extension:cms-enrollment-in-good-standing |  | 0..1 | boolean | CMS Enrollment In Good Standing URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-enrollment-in-good-standing
extension:ial2-verified |  | 0..1 | boolean | IAL2 Verified URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-ial2-verified
extension:aligned-with-cms-data-network |  | 0..1 | boolean | Aligned with CMS Data Network URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-aligned-with-cms-data-network
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)
extension:logo |  | 0..1 | Attachment | NDH Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ C | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this
identifier:All Slices |  |  |  | Content/Rules for all slices
Slices for extension |  |  |  | Content/Rules for all slices
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)
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 0..1 | string | The value that is unique Example General: 123456
assigner | Σ | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text)
identifier:NPI | S Σ C | 0..* | Identifier | National Provider Identifier (NPI) Constraints: us-core-16, us-core-17 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 0..1 | CodeableConcept | Description of identifier
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
value |  | 0..1 | string | The value that is unique
period |  | 0..1 | Period | Time period when id is/was valid for use
assigner |  | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:CLIA | Σ C | 0..* | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Constraints: us-core-18 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 0..1 | CodeableConcept | Description of identifier
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7
value |  | 0..1 | string | The value that is unique
period |  | 0..1 | Period | Time period when id is/was valid for use
assigner |  | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:NAIC | Σ C | 0..* | Identifier | NAIC Code Constraints: us-core-19 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 0..1 | CodeableConcept | Description of identifier
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.300
value |  | 0..1 | string | The value that is unique
period |  | 0..1 | Period | Time period when id is/was valid for use
assigner |  | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:TID | S Σ C | 0..1 | Identifier | Tax Identifier Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 0..1 | CodeableConcept | Description of identifier
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-ssn
value |  | 0..1 | string | The value that is unique
period |  | 0..1 | Period | Time period when id is/was valid for use
assigner |  | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
active | ?!S Σ | 1..1 | boolean | Whether the organization's record is still in active use Required Pattern: true
type | S Σ | 1..* | CodeableConcept | Kind of organization Binding: Organization Type Value Set (extensible)
name | S Σ C | 1..1 | string | Name used for the organization
alias | S | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
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)
extension:org-alias-period |  | 0..1 | Period | Organization Alias Period URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-period
telecom | S C | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
Slices for extension |  |  |  | Content/Rules for all slices
extension:contactpoint-availabletime |  | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary |  | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
extension:language-speak |  | 0..* | code | Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible)
system | S Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 0..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
address | S C | 0..* | Address | An address for the organization Constraints: org-2
Slices for extension |  |  |  | Content/Rules for all slices
extension:geolocation |  | 0..1 | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
line | S Σ | 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
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
country | S Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
partOf | Σ | 0..1 | Reference(NDH Organization Profile) | The organization of which this organization forms a part
endpoint | S | 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.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
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Organization | A resource should have narrative for robust management | `text.`div`.exists()`
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()`
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one | `(identifier.count() + name.count()) > 0`
org-2 | error | Organization.address | An address of an organization can never be of use 'home' | `where(use = 'home').empty()`
org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' | `where(use = 'home').empty()`
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, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-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
meta |  |  |  |
lastUpdated |  | 1..1 | instant | When the resource version last changed
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:rating |  | 0..* | (Complex) | NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
extension:paymentaccepted |  | 0..* | CodeableConcept | NDH Payment Accepted URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: Hl7VSPaymentMethodCode (2.0.0) (required)
extension:fundingSource |  | 0..* | (Complex) | NDH Funding Source URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
extension:org-description |  | 0..1 | string | Organization Description URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-description
extension:qualification |  | 0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
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
extension:cms-enrollment-in-good-standing |  | 0..1 | boolean | CMS Enrollment In Good Standing URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-enrollment-in-good-standing
extension:ial2-verified |  | 0..1 | boolean | IAL2 Verified URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-ial2-verified
extension:aligned-with-cms-data-network |  | 0..1 | boolean | Aligned with CMS Data Network URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-aligned-with-cms-data-network
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)
extension:logo |  | 0..1 | Attachment | NDH Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
identifier |  | 0..* | Identifier | Identifies this organization across multiple systems
Slices for extension |  |  |  | Content/Rules for all slices
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)
assigner |  | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text)
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:TID |  | 0..1 | Identifier | Tax Identifier Required Pattern: At least the following
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-ssn
active |  | 1..1 | boolean | Whether the organization's record is still in active use Required Pattern: true
type | S | 1..* | CodeableConcept | Kind of organization Binding: Organization Type Value Set (extensible)
alias | S | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
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)
extension:org-alias-period |  | 0..1 | Period | Organization Alias Period URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-period
telecom |  | 0..* | ContactPoint | A contact detail for the organization
Slices for extension |  |  |  | Content/Rules for all slices
extension:contactpoint-availabletime |  | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary |  | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
extension:language-speak |  | 0..* | code | Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible)
address |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:geolocation |  | 0..1 | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation
state |  | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
partOf |  | 0..1 | Reference(NDH Organization Profile) | The organization of which this organization forms a part
contact |  |  |  |
telecom |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:contactpoint-availabletime |  | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary |  | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
endpoint | S | 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

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
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 1..1 | instant | When the resource version last changed
source | Σ | 0..1 | uri | Identifies where the resource comes from
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 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".
implicitRules | ?!Σ | 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
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
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:rating |  | 0..* | (Complex) | NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
extension:paymentaccepted |  | 0..* | CodeableConcept | NDH Payment Accepted URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: Hl7VSPaymentMethodCode (2.0.0) (required)
extension:fundingSource |  | 0..* | (Complex) | NDH Funding Source URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
extension:org-description |  | 0..1 | string | Organization Description URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-description
extension:qualification |  | 0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
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
extension:cms-enrollment-in-good-standing |  | 0..1 | boolean | CMS Enrollment In Good Standing URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-enrollment-in-good-standing
extension:ial2-verified |  | 0..1 | boolean | IAL2 Verified URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-ial2-verified
extension:aligned-with-cms-data-network |  | 0..1 | boolean | Aligned with CMS Data Network URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-aligned-with-cms-data-network
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)
extension:logo |  | 0..1 | Attachment | NDH Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ C | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this
identifier:All Slices |  |  |  | Content/Rules for all slices
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: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)
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 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.
system | S Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 0..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text)
identifier:NPI | S Σ C | 0..* | Identifier | National Provider Identifier (NPI) Constraints: us-core-16, us-core-17 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 0..1 | CodeableConcept | Description of identifier
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
value |  | 0..1 | string | The value that is unique
period |  | 0..1 | Period | Time period when id is/was valid for use
assigner |  | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:CLIA | Σ C | 0..* | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Constraints: us-core-18 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 0..1 | CodeableConcept | Description of identifier
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7
value |  | 0..1 | string | The value that is unique
period |  | 0..1 | Period | Time period when id is/was valid for use
assigner |  | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:NAIC | Σ C | 0..* | Identifier | NAIC Code Constraints: us-core-19 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 0..1 | CodeableConcept | Description of identifier
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.300
value |  | 0..1 | string | The value that is unique
period |  | 0..1 | Period | Time period when id is/was valid for use
assigner |  | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:TID | S Σ C | 0..1 | Identifier | Tax Identifier Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 0..1 | CodeableConcept | Description of identifier
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-ssn
value |  | 0..1 | string | The value that is unique
period |  | 0..1 | Period | Time period when id is/was valid for use
assigner |  | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
active | ?!S Σ | 1..1 | boolean | Whether the organization's record is still in active use Required Pattern: true
type | S Σ | 1..* | CodeableConcept | Kind of organization Binding: Organization Type Value Set (extensible)
name | S Σ C | 1..1 | string | Name used for the organization
alias | S | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
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)
extension:org-alias-period |  | 0..1 | Period | Organization Alias Period URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-period
value |  | 0..1 | string | Primitive value for string Max Length:1048576
telecom | S C | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
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:contactpoint-availabletime |  | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary |  | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
extension:language-speak |  | 0..* | code | Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible)
system | S Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 0..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
address | S C | 0..* | Address | An address for the organization Constraints: org-2
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:geolocation |  | 0..1 | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | S Σ | 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
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
country | S Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
partOf | Σ | 0..1 | Reference(NDH Organization Profile) | The organization of which this organization forms a part
contact |  | 0..* | BackboneElement | Contact for the organization for a certain purpose
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
purpose |  | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
name |  | 0..1 | HumanName | A name associated with the contact
telecom |  | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact
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:contactpoint-availabletime |  | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary |  | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
system | Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | Σ | 0..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
address |  | 0..1 | Address | Visiting or postal addresses for the contact
endpoint | S | 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.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.
Organization.contact.​telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Organization.contact.​telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Organization | A resource should have narrative for robust management | `text.`div`.exists()`
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()`
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one | `(identifier.count() + name.count()) > 0`
org-2 | error | Organization.address | An address of an organization can never be of use 'home' | `where(use = 'home').empty()`
org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' | `where(use = 'home').empty()`
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, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-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(1 nested mandatory element)
Must-Support: 3 elements

Structures

This structure refers to these other structures:

- NDH Organization Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization)
- NDH Endpoint Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Endpoint)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-description
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-insuranceplan-reference
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-enrollment-in-good-standing
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-ial2-verified
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-aligned-with-cms-data-network
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-type
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-period
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak
- http://hl7.org/fhir/StructureDefinition/geolocation|4.0.1

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
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:rating |  | 0..* | (Complex) | NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
extension:paymentaccepted |  | 0..* | CodeableConcept | NDH Payment Accepted URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: Hl7VSPaymentMethodCode (2.0.0) (required)
extension:fundingSource |  | 0..* | (Complex) | NDH Funding Source URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
extension:org-description |  | 0..1 | string | Organization Description URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-description
extension:qualification |  | 0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
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
extension:cms-enrollment-in-good-standing |  | 0..1 | boolean | CMS Enrollment In Good Standing URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-enrollment-in-good-standing
extension:ial2-verified |  | 0..1 | boolean | IAL2 Verified URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-ial2-verified
extension:aligned-with-cms-data-network |  | 0..1 | boolean | Aligned with CMS Data Network URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-aligned-with-cms-data-network
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)
extension:logo |  | 0..1 | Attachment | NDH Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ C | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this
identifier:All Slices |  |  |  | Content/Rules for all slices
Slices for extension |  |  |  | Content/Rules for all slices
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)
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 0..1 | string | The value that is unique Example General: 123456
assigner | Σ | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text)
identifier:NPI | S Σ C | 0..* | Identifier | National Provider Identifier (NPI) Constraints: us-core-16, us-core-17 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 0..1 | CodeableConcept | Description of identifier
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
value |  | 0..1 | string | The value that is unique
period |  | 0..1 | Period | Time period when id is/was valid for use
assigner |  | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:CLIA | Σ C | 0..* | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Constraints: us-core-18 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 0..1 | CodeableConcept | Description of identifier
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7
value |  | 0..1 | string | The value that is unique
period |  | 0..1 | Period | Time period when id is/was valid for use
assigner |  | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:NAIC | Σ C | 0..* | Identifier | NAIC Code Constraints: us-core-19 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 0..1 | CodeableConcept | Description of identifier
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.300
value |  | 0..1 | string | The value that is unique
period |  | 0..1 | Period | Time period when id is/was valid for use
assigner |  | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:TID | S Σ C | 0..1 | Identifier | Tax Identifier Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 0..1 | CodeableConcept | Description of identifier
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-ssn
value |  | 0..1 | string | The value that is unique
period |  | 0..1 | Period | Time period when id is/was valid for use
assigner |  | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
active | ?!S Σ | 1..1 | boolean | Whether the organization's record is still in active use Required Pattern: true
type | S Σ | 1..* | CodeableConcept | Kind of organization Binding: Organization Type Value Set (extensible)
name | S Σ C | 1..1 | string | Name used for the organization
alias | S | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
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)
extension:org-alias-period |  | 0..1 | Period | Organization Alias Period URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-period
telecom | S C | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
Slices for extension |  |  |  | Content/Rules for all slices
extension:contactpoint-availabletime |  | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary |  | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
extension:language-speak |  | 0..* | code | Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible)
system | S Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 0..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
address | S C | 0..* | Address | An address for the organization Constraints: org-2
Slices for extension |  |  |  | Content/Rules for all slices
extension:geolocation |  | 0..1 | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
line | S Σ | 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
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
country | S Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
partOf | Σ | 0..1 | Reference(NDH Organization Profile) | The organization of which this organization forms a part
endpoint | S | 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.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
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Organization | A resource should have narrative for robust management | `text.`div`.exists()`
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()`
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one | `(identifier.count() + name.count()) > 0`
org-2 | error | Organization.address | An address of an organization can never be of use 'home' | `where(use = 'home').empty()`
org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' | `where(use = 'home').empty()`
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, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-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
meta |  |  |  |
lastUpdated |  | 1..1 | instant | When the resource version last changed
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:rating |  | 0..* | (Complex) | NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
extension:paymentaccepted |  | 0..* | CodeableConcept | NDH Payment Accepted URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: Hl7VSPaymentMethodCode (2.0.0) (required)
extension:fundingSource |  | 0..* | (Complex) | NDH Funding Source URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
extension:org-description |  | 0..1 | string | Organization Description URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-description
extension:qualification |  | 0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
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
extension:cms-enrollment-in-good-standing |  | 0..1 | boolean | CMS Enrollment In Good Standing URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-enrollment-in-good-standing
extension:ial2-verified |  | 0..1 | boolean | IAL2 Verified URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-ial2-verified
extension:aligned-with-cms-data-network |  | 0..1 | boolean | Aligned with CMS Data Network URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-aligned-with-cms-data-network
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)
extension:logo |  | 0..1 | Attachment | NDH Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
identifier |  | 0..* | Identifier | Identifies this organization across multiple systems
Slices for extension |  |  |  | Content/Rules for all slices
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)
assigner |  | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text)
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:TID |  | 0..1 | Identifier | Tax Identifier Required Pattern: At least the following
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-ssn
active |  | 1..1 | boolean | Whether the organization's record is still in active use Required Pattern: true
type | S | 1..* | CodeableConcept | Kind of organization Binding: Organization Type Value Set (extensible)
alias | S | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
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)
extension:org-alias-period |  | 0..1 | Period | Organization Alias Period URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-period
telecom |  | 0..* | ContactPoint | A contact detail for the organization
Slices for extension |  |  |  | Content/Rules for all slices
extension:contactpoint-availabletime |  | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary |  | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
extension:language-speak |  | 0..* | code | Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible)
address |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:geolocation |  | 0..1 | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation
state |  | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
partOf |  | 0..1 | Reference(NDH Organization Profile) | The organization of which this organization forms a part
contact |  |  |  |
telecom |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:contactpoint-availabletime |  | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary |  | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
endpoint | S | 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 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
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 1..1 | instant | When the resource version last changed
source | Σ | 0..1 | uri | Identifies where the resource comes from
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 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".
implicitRules | ?!Σ | 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
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
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:rating |  | 0..* | (Complex) | NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
extension:paymentaccepted |  | 0..* | CodeableConcept | NDH Payment Accepted URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: Hl7VSPaymentMethodCode (2.0.0) (required)
extension:fundingSource |  | 0..* | (Complex) | NDH Funding Source URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
extension:org-description |  | 0..1 | string | Organization Description URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-description
extension:qualification |  | 0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
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
extension:cms-enrollment-in-good-standing |  | 0..1 | boolean | CMS Enrollment In Good Standing URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-enrollment-in-good-standing
extension:ial2-verified |  | 0..1 | boolean | IAL2 Verified URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-ial2-verified
extension:aligned-with-cms-data-network |  | 0..1 | boolean | Aligned with CMS Data Network URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-aligned-with-cms-data-network
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)
extension:logo |  | 0..1 | Attachment | NDH Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ C | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this
identifier:All Slices |  |  |  | Content/Rules for all slices
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: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)
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 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.
system | S Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 0..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text)
identifier:NPI | S Σ C | 0..* | Identifier | National Provider Identifier (NPI) Constraints: us-core-16, us-core-17 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 0..1 | CodeableConcept | Description of identifier
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
value |  | 0..1 | string | The value that is unique
period |  | 0..1 | Period | Time period when id is/was valid for use
assigner |  | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:CLIA | Σ C | 0..* | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Constraints: us-core-18 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 0..1 | CodeableConcept | Description of identifier
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7
value |  | 0..1 | string | The value that is unique
period |  | 0..1 | Period | Time period when id is/was valid for use
assigner |  | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:NAIC | Σ C | 0..* | Identifier | NAIC Code Constraints: us-core-19 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 0..1 | CodeableConcept | Description of identifier
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.300
value |  | 0..1 | string | The value that is unique
period |  | 0..1 | Period | Time period when id is/was valid for use
assigner |  | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:TID | S Σ C | 0..1 | Identifier | Tax Identifier Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 0..1 | CodeableConcept | Description of identifier
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-ssn
value |  | 0..1 | string | The value that is unique
period |  | 0..1 | Period | Time period when id is/was valid for use
assigner |  | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
active | ?!S Σ | 1..1 | boolean | Whether the organization's record is still in active use Required Pattern: true
type | S Σ | 1..* | CodeableConcept | Kind of organization Binding: Organization Type Value Set (extensible)
name | S Σ C | 1..1 | string | Name used for the organization
alias | S | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
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)
extension:org-alias-period |  | 0..1 | Period | Organization Alias Period URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-period
value |  | 0..1 | string | Primitive value for string Max Length:1048576
telecom | S C | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
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:contactpoint-availabletime |  | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary |  | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
extension:language-speak |  | 0..* | code | Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible)
system | S Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 0..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
address | S C | 0..* | Address | An address for the organization Constraints: org-2
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:geolocation |  | 0..1 | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | S Σ | 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
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
country | S Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
partOf | Σ | 0..1 | Reference(NDH Organization Profile) | The organization of which this organization forms a part
contact |  | 0..* | BackboneElement | Contact for the organization for a certain purpose
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
purpose |  | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
name |  | 0..1 | HumanName | A name associated with the contact
telecom |  | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact
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:contactpoint-availabletime |  | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary |  | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
system | Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | Σ | 0..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
address |  | 0..1 | Address | Visiting or postal addresses for the contact
endpoint | S | 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.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.
Organization.contact.​telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Organization.contact.​telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Organization | A resource should have narrative for robust management | `text.`div`.exists()`
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()`
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one | `(identifier.count() + name.count()) > 0`
org-2 | error | Organization.address | An address of an organization can never be of use 'home' | `where(use = 'home').empty()`
org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' | `where(use = 'home').empty()`
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, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-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(1 nested mandatory element)
Must-Support: 3 elements

Structures

This structure refers to these other structures:

- NDH Organization Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization)
- NDH Endpoint Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Endpoint)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-description
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-insuranceplan-reference
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-enrollment-in-good-standing
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-ial2-verified
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-aligned-with-cms-data-network
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-type
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-period
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak
- http://hl7.org/fhir/StructureDefinition/geolocation|4.0.1

Maturity: 4

Other representations of profile: CSV, Excel, Schematron

### Notes:

### Search Parameters

#### Search Parameter defined by the NDH IG

SearchParameter Name | Type | Example
--- | --- | ---
verification-status | token | `GET [base]/Organization?verification-status=complete`

#### Search Parameter defined by FHIR Search Parameter Registry and used by the NDH IG

Since there is no direct individual url for each Search Parameter defined by FHIR Serach Parameter Registry, we have provided the following links for you to access more information about them.

- Search Parameter Registry
- Organization Search Parameter from Registry

SearchParameter Name | Type | Example
--- | --- | ---
active | token | `GET [base]/Organization?active=true`
address | string | `GET [base]/Organization?address=123 Ravissant Dr`
address-city | string | `GET [base]/Organization?address-city=Coconut Creek`
address-country | string | `GET [base]/Organization?address-country=USA`
address-postalcode | string | `GET [base]/Organization?address-postcode=12345`
address-state | string | `GET [base]/Organization?address-state=FL`
address-use | token | `GET [base]/Organization?address-use=work`
endpoint | reference | `GET [base]/Organization?endpoint.connection-type=hl7-fhir-rest`
identifier | token | `GET [base]/Organization?identifier=12345`
name | string | `GET [base]/Organization?name=Florida Blue`
partof | reference | `GET [base]/Organization?partof.name=Florida Blue`

#### _include Search Parameter

include | Example
--- | ---
Organization:endpoint | `GET [base]/Organization?_include=Organization:endpoint`
Organization:partof | `GET [base]/Organization?_include=Organization:partof`

#### _revinclude Search Parameter

_revinclude | Notes
--- | ---
Endpoint:organization |
HealthcareService:organization | HealthcareService.providedBy
InsurancePlan:administered-by |
InsurancePlan:owned-by |
Location:organization |
OrganizationAffiliation:participating-organization |
OrganizationAffiliation:primary-organization |
Practitioner:qualification-issuer |
PractitionerRole:organization |

#### Special Search Parameters

The search parameters outlined above are straightforward for basic scenarios but have limitations in handling complex combination queries. To enhance these capabilities, employing the special search parameters _filter is recommended.