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 Network Profile

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Network | Version: 2.0.0-current
Standards status: Trial-use | Maturity Level: 4 | Computable Name: NdhNetwork

A Network refers to a healthcare provider insurance network. A healthcare provider insurance network is an aggregation of organizations and individuals that deliver a set of services across a geography through health insurance products/plans. In the NDH IG, individuals and organizations are represented as participants in a National Directory Exchange Network through the practitionerRole and National Directory Exchange-organizationAffiliation resources, respectively.

### Scope and Usage

- In The National Directory of Healthcare Providers & Services (NDH) IG, individuals and organizations are represented as participants in a Network through the practitionerRole and organizationAffiliation resources, respectively.

- The Network profile is based on USCore Organization Profile. However, the NPI and CLIA identifier types, which are Must-Support, are clearly intended for provider organizations only and are not expected to be populated for other organization types.

- The NDH Network and Organization 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.

- 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.

- Note that the relationship between InsurancePlans and Networks is many-to-many. A plan may be associated with multiple networks, and a network may be associated with many plans. In this IG, this is modeled by having InsurancePlans reference networks (directionality of relationship supports this).

- To use the location-reference extension to indicate a network coverage area, the preferred form of reference is to create a Location instance with the State or region specified, and possibly provide a GeoJSON.

Usages:

- Refer to this Profile: NDH Network Reference, NDH New Patients, NDH InsurancePlan Profile and NDH OrganizationAffiliation Profile
- Examples for this Profile: ACME CT Premium Preferred Provider Network, ACME CT Preferred Provider Network, BlueCrossBlueShield CT PPO, Network1... Show 4 more, Network2, NetworkGen1, NetworkGen2 and Social Service Housing Hub
- 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:location |  | 0..* | Reference(NDH Location Profile) | Network coverage area URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference
extension:organization-period |  | 0..1 | Period | Valid time period for this Network URL: http://hl7.org/fhir/StructureDefinition/organization-period
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)
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)
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible)
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: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)
active | ?!S Σ | 1..1 | boolean | Whether the organization's record is still in active use Fixed Value: true
type | S Σ | 1..1 | CodeableConcept | Kind of organization Binding: Network Type Value Set (required)
name | S Σ C | 1..1 | string | Name used for the organization
telecom | S C | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
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
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 | S Σ | 1..1 | Reference(NDH Organization Profile) | The organization that manages this network
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.identifier.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
Organization.type | Base | required | Network 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-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:location |  | 0..* | Reference(NDH Location Profile) | Network coverage area URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference
extension:organization-period |  | 0..1 | Period | Valid time period for this Network URL: http://hl7.org/fhir/StructureDefinition/organization-period
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)
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)
use |  | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required)
type |  | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible)
assigner |  | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text)
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:NPI |  | 0..0 |  | National Provider Identifier (NPI)
identifier:CLIA |  | 0..0 |  | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
active |  | 1..1 | boolean | Whether the organization's record is still in active use Fixed Value: true
type | S | 1..1 | CodeableConcept | Kind of organization Binding: Network Type Value Set (required)
address |  |  |  |
state |  | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
partOf | S | 1..1 | Reference(NDH Organization Profile) | The organization that manages this network
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
address |  |  |  |
state |  | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
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.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Organization.identifier.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
Organization.type | Base | required | Network 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
Organization.contact.​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:location |  | 0..* | Reference(NDH Location Profile) | Network coverage area URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference
extension:organization-period |  | 0..1 | Period | Valid time period for this Network URL: http://hl7.org/fhir/StructureDefinition/organization-period
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)
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)
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible)
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: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)
active | ?!S Σ | 1..1 | boolean | Whether the organization's record is still in active use Fixed Value: true
type | S Σ | 1..1 | CodeableConcept | Kind of organization Binding: Network Type Value Set (required)
name | S Σ C | 1..1 | string | Name used for the organization
alias |  | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past
telecom | S C | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
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
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
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 | S Σ | 1..1 | Reference(NDH Organization Profile) | The organization that manages this network
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
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
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 | Σ | 0..* | 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 | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132
country | Σ | 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"}
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 | required | Network 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.
Organization.contact.​address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Organization.contact.​address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std.
Organization.contact.​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-19 | error | Organization.identifier:NAIC | NAIC must be 5 digits | `value.matches('^[0-9]{5}$')`

This structure is derived from USCoreOrganizationProfile

Summary

Mandatory: 2 elements(1 nested mandatory element)
Must-Support: 3 elements
Fixed: 1 element
Prohibited: 2 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-location-reference
- http://hl7.org/fhir/StructureDefinition/organization-period|4.0.1
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary

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:location |  | 0..* | Reference(NDH Location Profile) | Network coverage area URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference
extension:organization-period |  | 0..1 | Period | Valid time period for this Network URL: http://hl7.org/fhir/StructureDefinition/organization-period
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)
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)
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible)
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: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)
active | ?!S Σ | 1..1 | boolean | Whether the organization's record is still in active use Fixed Value: true
type | S Σ | 1..1 | CodeableConcept | Kind of organization Binding: Network Type Value Set (required)
name | S Σ C | 1..1 | string | Name used for the organization
telecom | S C | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
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
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 | S Σ | 1..1 | Reference(NDH Organization Profile) | The organization that manages this network
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.identifier.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
Organization.type | Base | required | Network 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-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:location |  | 0..* | Reference(NDH Location Profile) | Network coverage area URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference
extension:organization-period |  | 0..1 | Period | Valid time period for this Network URL: http://hl7.org/fhir/StructureDefinition/organization-period
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)
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)
use |  | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required)
type |  | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible)
assigner |  | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text)
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:NPI |  | 0..0 |  | National Provider Identifier (NPI)
identifier:CLIA |  | 0..0 |  | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
active |  | 1..1 | boolean | Whether the organization's record is still in active use Fixed Value: true
type | S | 1..1 | CodeableConcept | Kind of organization Binding: Network Type Value Set (required)
address |  |  |  |
state |  | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
partOf | S | 1..1 | Reference(NDH Organization Profile) | The organization that manages this network
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
address |  |  |  |
state |  | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
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.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Organization.identifier.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
Organization.type | Base | required | Network 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
Organization.contact.​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:location |  | 0..* | Reference(NDH Location Profile) | Network coverage area URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference
extension:organization-period |  | 0..1 | Period | Valid time period for this Network URL: http://hl7.org/fhir/StructureDefinition/organization-period
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)
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)
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible)
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: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)
active | ?!S Σ | 1..1 | boolean | Whether the organization's record is still in active use Fixed Value: true
type | S Σ | 1..1 | CodeableConcept | Kind of organization Binding: Network Type Value Set (required)
name | S Σ C | 1..1 | string | Name used for the organization
alias |  | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past
telecom | S C | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
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
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
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 | S Σ | 1..1 | Reference(NDH Organization Profile) | The organization that manages this network
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
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
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 | Σ | 0..* | 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 | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132
country | Σ | 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"}
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 | required | Network 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.
Organization.contact.​address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Organization.contact.​address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std.
Organization.contact.​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-19 | error | Organization.identifier:NAIC | NAIC must be 5 digits | `value.matches('^[0-9]{5}$')`

This structure is derived from USCoreOrganizationProfile

Summary

Mandatory: 2 elements(1 nested mandatory element)
Must-Support: 3 elements
Fixed: 1 element
Prohibited: 2 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-location-reference
- http://hl7.org/fhir/StructureDefinition/organization-period|4.0.1
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary

Maturity: 4

Other representations of profile: CSV, Excel, Schematron

### Notes:

### Search Parameters

#### Search Parameter defined by the NDH IG

In order to obtain information related to the Network resource, which is a derivative of the Organization resource, it is necessary to include the type=ntwk parameter in your search query.

SearchParameter Name | Type | Example
--- | --- | ---
coverage-area | reference | `GET [base]/Organization?type=ntwk&coverage-area.address-state=CT`
verification-status | token | `GET [base]/Organization?type=ntwk&verification-status=complete`

This search returns networks have coverage in the State of CT.

#### 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
- Network Search Parameter from Registry

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

#### _include Search Parameter

include | Example
--- | ---
Organization:coverage-area | `GET [base]/Organization?type=ntwk&_include=Organization:coverage-area`

#### _revinclude Search Parameter

_revinclude | Example
--- | ---
HealthcareService:network | `GET [base]/Organization?type=ntwk&_revinclude=HealthcareService:network`
HealthcareService:new-patient-from-network | `GET [base]/Organization?type=ntwk&_revinclude=HealthcareService:new-patient-from-network`
InsurancePlan:coverage-network | `GET [base]/Organization?type=ntwk&_revinclude=InsurancePlan:coverage-network`
InsurancePlan:plan-network | `GET [base]/Organization?type=ntwk&_revinclude=InsurancePlan:plan-network`
InsurancePlan:network | `GET [base]/Organization?type=ntwk&_revinclude=InsurancePlan:network`
Location:new-patient-from-network | `GET [base]/Organization?type=ntwk&_revinclude=Location:new-patient-from-network`
OrganizationAffiliation:network | `GET [base]/Organization?type=ntwk&_revinclude=OrganizationAffiliation:network`
PractitionerRole:network | `GET [base]/Organization?type=ntwk&_revinclude=PractitionerRole:network`
PractitionerRole:new-patient-from-network | `GET [base]/Organization?type=ntwk&_revinclude=PractitionerRole:new-patient-from-network`