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

National Directory of Healthcare Providers & Services (NDH) Implementation Guide, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 2.0.0-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
Other Identifiers: OID:2.16.840.1.113883.4.642.40.43.42.45

This profile enables NDH to represent payer and provider network structures as computable directory data so users can determine network participation, geographic coverage, and organizational relationships that affect access and coverage decisions; it adds extensions for coverage-area references, organization period, and verification, and uses ValueSet bindings to standardize network type and key identifier semantics.

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:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Organization C 0..* USCoreOrganizationProfile(6.1.0) A grouping of people or organizations with a common purpose
Constraints: org-1
Organization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Organization.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for extension.extension:location 0..* Reference(NDH Location Profile) Network coverage area
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference
Organization.Slices for extension.extension:organization-period 0..1 Period Valid time period for this Network
URL: http://hl7.org/fhir/StructureDefinition/organization-period
Organization.Slices for extension.extension:verification-status 0..1 CodeableConcept NDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
Organization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Organization.Slices for identifier This element must be supported. This element is included in summaries. C 0..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this, value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:All Slices Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.Slices for extension Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.Slices for extension.extension:identifier-status 0..1 code NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
Organization.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Organization.Slices for identifier.identifier:All Slices.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
Organization.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Organization.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Organization.Slices for identifier.identifier:All Slices.assigner This element is included in summaries. 0..1 Reference(NDH Organization Profile) Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:NAIC This element is included in summaries. C 0..* Identifier NAIC Code
Constraints: us-core-19

Required Pattern:
{
  "system" : "urn:oid:2.16.840.1.113883.6.300"
}
Organization.Slices for identifier.identifier:PIN This element is included in summaries. C 0..* Identifier Payer Identification Number
Organization.Slices for identifier.identifier:PIN.Slices for extension Content/Rules for all slices
Organization.Slices for identifier.identifier:PIN.Slices for extension.extension:identifier-status 0..1 code NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
Organization.Slices for identifier.identifier:PIN.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:PIN.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "PAYERID"
    }
  ]
}
Organization.Slices for identifier.identifier:PIN.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Organization.Slices for identifier.identifier:PIN.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Organization.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether the organization's record is still in active use
Fixed Value: true (no extensions allowed)
Organization.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Kind of organization
Binding: Network Type Value Set (required)
Organization.name This element must be supported. This element is included in summaries. C 1..1 string Name used for the organization
Organization.telecom This element must be supported. C 0..* ContactPoint A contact detail for the organization
Constraints: org-3
Organization.telecom.system This element must be supported. This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Organization.telecom.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
Organization.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.address This element must be supported. C 0..* Address An address for the organization
Constraints: org-2
Organization.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Organization.address.line This element must be supported. This element is included in summaries. 0..4 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Organization.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Organization.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
Organization.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Organization.address.country This element must be supported. This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Organization.partOf This element must be supported. This element is included in summaries. 1..1 Reference(NDH Organization Profile) The organization that manages this network
Organization.contact 0..* BackboneElement Contact for the organization for a certain purpose
Organization.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Organization.contact.name 0..1 HumanName A name associated with the contact
Organization.contact.telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
Organization.contact.address 0..1 Address Visiting or postal addresses for the contact
Organization.contact.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Organization.contact.address.state This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
Organization.endpoint This element must be supported. 0..* Reference(NDH Endpoint Profile) Technical endpoints providing access to services operated for the organization

doco 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.identifier:PIN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:PIN.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Organization.type Base 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
Organization.contact.​address.use Base required AddressUse 📍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
us-core-19 error Organization.identifier:NAIC NAIC must be 5 digits value.matches('^[0-9]{5}$')

This structure is derived from USCoreOrganizationProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Organization 0..* USCoreOrganizationProfile(6.1.0) A grouping of people or organizations with a common purpose
Organization.meta
Organization.meta.lastUpdated 1..1 instant When the resource version last changed
Organization.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for extension.extension:location 0..* Reference(NDH Location Profile) Network coverage area
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference
Organization.Slices for extension.extension:organization-period 0..1 Period Valid time period for this Network
URL: http://hl7.org/fhir/StructureDefinition/organization-period
Organization.Slices for extension.extension:verification-status 0..1 CodeableConcept NDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
Organization.Slices for identifier 0..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this, value:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:All Slices Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.Slices for extension Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.Slices for extension.extension:identifier-status 0..1 code NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
Organization.Slices for identifier.identifier:All Slices.use 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Organization.Slices for identifier.identifier:All Slices.type 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
Organization.Slices for identifier.identifier:All Slices.assigner 0..1 Reference(NDH Organization Profile) Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:NPI 0..0 National Provider Identifier (NPI)
Organization.Slices for identifier.identifier:CLIA 0..0 Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
Organization.Slices for identifier.identifier:PIN 0..* Identifier Payer Identification Number
Organization.Slices for identifier.identifier:PIN.Slices for extension Content/Rules for all slices
Organization.Slices for identifier.identifier:PIN.Slices for extension.extension:identifier-status 0..1 code NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
Organization.Slices for identifier.identifier:PIN.type 1..1 CodeableConcept Description of identifier
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "PAYERID"
    }
  ]
}
Organization.Slices for identifier.identifier:PIN.system 1..1 uri The namespace for the identifier value
Organization.Slices for identifier.identifier:PIN.value 1..1 string The value that is unique
Organization.type This element must be supported. 1..1 CodeableConcept Kind of organization
Binding: Network Type Value Set (required)
Organization.name 1..1 string Name used for the organization
Organization.address
Organization.address.line 0..4 string Street name, number, direction & P.O. Box etc.
Organization.address.city 0..1 string Name of city, town etc.
Organization.address.state 0..1 string Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
Organization.address.postalCode 0..1 string US Zip Codes
Organization.address.country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Organization.partOf This element must be supported. 1..1 Reference(NDH Organization Profile) The organization that manages this network
Organization.contact 0..* BackboneElement Contact for the organization for a certain purpose
Organization.contact.name 0..1 HumanName A name associated with the contact
Organization.contact.telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
Organization.contact.address 0..1 Address Visiting or postal addresses for the contact
Organization.contact.address.state 0..1 string Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
Organization.endpoint This element must be supported. 0..* Reference(NDH Endpoint Profile) Technical endpoints providing access to services operated for the organization

doco 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
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Organization C 0..* USCoreOrganizationProfile(6.1.0) A grouping of people or organizations with a common purpose
Constraints: org-1
Organization.id This element is included in summaries. 0..1 id Logical id of this artifact
Organization.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Organization.meta.id 0..1 string Unique id for inter-element referencing
Organization.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Organization.meta.lastUpdated This element is included in summaries. 1..1 instant When the resource version last changed
Organization.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Organization.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Organization.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Organization.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Organization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Organization.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Organization.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Organization.contained 0..* Resource Contained, inline Resources
Organization.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for extension.extension:location 0..* Reference(NDH Location Profile) Network coverage area
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference
Organization.Slices for extension.extension:organization-period 0..1 Period Valid time period for this Network
URL: http://hl7.org/fhir/StructureDefinition/organization-period
Organization.Slices for extension.extension:verification-status 0..1 CodeableConcept NDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
Organization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Organization.Slices for identifier This element must be supported. This element is included in summaries. C 0..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this, value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:All Slices Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.id 0..1 string Unique id for inter-element referencing
Organization.Slices for identifier.identifier:All Slices.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:All Slices.Slices for extension.extension:identifier-status 0..1 code NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
Organization.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Organization.Slices for identifier.identifier:All Slices.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
Organization.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Organization.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Organization.Slices for identifier.identifier:All Slices.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Organization.Slices for identifier.identifier:All Slices.assigner This element is included in summaries. 0..1 Reference(NDH Organization Profile) Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:NAIC This element is included in summaries. C 0..* Identifier NAIC Code
Constraints: us-core-19

Required Pattern:
{
  "system" : "urn:oid:2.16.840.1.113883.6.300"
}
Organization.Slices for identifier.identifier:PIN This element is included in summaries. C 0..* Identifier Payer Identification Number
Organization.Slices for identifier.identifier:PIN.id 0..1 string Unique id for inter-element referencing
Organization.Slices for identifier.identifier:PIN.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:PIN.Slices for extension Content/Rules for all slices
Organization.Slices for identifier.identifier:PIN.Slices for extension.extension:identifier-status 0..1 code NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
Organization.Slices for identifier.identifier:PIN.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:PIN.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "PAYERID"
    }
  ]
}
Organization.Slices for identifier.identifier:PIN.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Organization.Slices for identifier.identifier:PIN.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Organization.Slices for identifier.identifier:PIN.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Organization.Slices for identifier.identifier:PIN.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Organization.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether the organization's record is still in active use
Fixed Value: true (no extensions allowed)
Organization.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Kind of organization
Binding: Network Type Value Set (required)
Organization.name This element must be supported. This element is included in summaries. C 1..1 string Name used for the organization
Organization.alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
Organization.telecom This element must be supported. C 0..* ContactPoint A contact detail for the organization
Constraints: org-3
Organization.telecom.id 0..1 string Unique id for inter-element referencing
Organization.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.telecom.system This element must be supported. This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Organization.telecom.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
Organization.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Organization.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Organization.address This element must be supported. C 0..* Address An address for the organization
Constraints: org-2
Organization.address.id 0..1 string Unique id for inter-element referencing
Organization.address.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Organization.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Organization.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Organization.address.line This element must be supported. This element is included in summaries. 0..4 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Organization.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Organization.address.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Organization.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
Organization.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Organization.address.country This element must be supported. This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Organization.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Organization.partOf This element must be supported. This element is included in summaries. 1..1 Reference(NDH Organization Profile) The organization that manages this network
Organization.contact 0..* BackboneElement Contact for the organization for a certain purpose
Organization.contact.id 0..1 string Unique id for inter-element referencing
Organization.contact.extension 0..* Extension Additional content defined by implementations
Organization.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Organization.contact.purpose 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
Organization.contact.name 0..1 HumanName A name associated with the contact
Organization.contact.telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
Organization.contact.address 0..1 Address Visiting or postal addresses for the contact
Organization.contact.address.id 0..1 string Unique id for inter-element referencing
Organization.contact.address.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.contact.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Organization.contact.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Organization.contact.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Organization.contact.address.line This element is included in summaries. 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
Organization.contact.address.city This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Organization.contact.address.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Organization.contact.address.state This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
Organization.contact.address.postalCode This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
Organization.contact.address.country This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Organization.contact.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Organization.endpoint This element must be supported. 0..* Reference(NDH Endpoint Profile) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Organization.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Organization.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Organization.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Organization.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Organization.identifier:PIN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:PIN.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Organization.type Base 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.​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
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(4 nested mandatory elements)
Must-Support: 3 elements
Fixed: 1 element
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

Maturity: 4

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Organization C 0..* USCoreOrganizationProfile(6.1.0) A grouping of people or organizations with a common purpose
Constraints: org-1
Organization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Organization.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for extension.extension:location 0..* Reference(NDH Location Profile) Network coverage area
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference
Organization.Slices for extension.extension:organization-period 0..1 Period Valid time period for this Network
URL: http://hl7.org/fhir/StructureDefinition/organization-period
Organization.Slices for extension.extension:verification-status 0..1 CodeableConcept NDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
Organization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Organization.Slices for identifier This element must be supported. This element is included in summaries. C 0..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this, value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:All Slices Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.Slices for extension Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.Slices for extension.extension:identifier-status 0..1 code NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
Organization.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Organization.Slices for identifier.identifier:All Slices.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
Organization.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Organization.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Organization.Slices for identifier.identifier:All Slices.assigner This element is included in summaries. 0..1 Reference(NDH Organization Profile) Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:NAIC This element is included in summaries. C 0..* Identifier NAIC Code
Constraints: us-core-19

Required Pattern:
{
  "system" : "urn:oid:2.16.840.1.113883.6.300"
}
Organization.Slices for identifier.identifier:PIN This element is included in summaries. C 0..* Identifier Payer Identification Number
Organization.Slices for identifier.identifier:PIN.Slices for extension Content/Rules for all slices
Organization.Slices for identifier.identifier:PIN.Slices for extension.extension:identifier-status 0..1 code NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
Organization.Slices for identifier.identifier:PIN.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:PIN.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "PAYERID"
    }
  ]
}
Organization.Slices for identifier.identifier:PIN.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Organization.Slices for identifier.identifier:PIN.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Organization.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether the organization's record is still in active use
Fixed Value: true (no extensions allowed)
Organization.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Kind of organization
Binding: Network Type Value Set (required)
Organization.name This element must be supported. This element is included in summaries. C 1..1 string Name used for the organization
Organization.telecom This element must be supported. C 0..* ContactPoint A contact detail for the organization
Constraints: org-3
Organization.telecom.system This element must be supported. This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Organization.telecom.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
Organization.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.address This element must be supported. C 0..* Address An address for the organization
Constraints: org-2
Organization.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Organization.address.line This element must be supported. This element is included in summaries. 0..4 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Organization.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Organization.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
Organization.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Organization.address.country This element must be supported. This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Organization.partOf This element must be supported. This element is included in summaries. 1..1 Reference(NDH Organization Profile) The organization that manages this network
Organization.contact 0..* BackboneElement Contact for the organization for a certain purpose
Organization.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Organization.contact.name 0..1 HumanName A name associated with the contact
Organization.contact.telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
Organization.contact.address 0..1 Address Visiting or postal addresses for the contact
Organization.contact.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Organization.contact.address.state This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
Organization.endpoint This element must be supported. 0..* Reference(NDH Endpoint Profile) Technical endpoints providing access to services operated for the organization

doco 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.identifier:PIN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:PIN.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Organization.type Base 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
Organization.contact.​address.use Base required AddressUse 📍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
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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Organization 0..* USCoreOrganizationProfile(6.1.0) A grouping of people or organizations with a common purpose
Organization.meta
Organization.meta.lastUpdated 1..1 instant When the resource version last changed
Organization.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for extension.extension:location 0..* Reference(NDH Location Profile) Network coverage area
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference
Organization.Slices for extension.extension:organization-period 0..1 Period Valid time period for this Network
URL: http://hl7.org/fhir/StructureDefinition/organization-period
Organization.Slices for extension.extension:verification-status 0..1 CodeableConcept NDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
Organization.Slices for identifier 0..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this, value:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:All Slices Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.Slices for extension Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.Slices for extension.extension:identifier-status 0..1 code NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
Organization.Slices for identifier.identifier:All Slices.use 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Organization.Slices for identifier.identifier:All Slices.type 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
Organization.Slices for identifier.identifier:All Slices.assigner 0..1 Reference(NDH Organization Profile) Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:NPI 0..0 National Provider Identifier (NPI)
Organization.Slices for identifier.identifier:CLIA 0..0 Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
Organization.Slices for identifier.identifier:PIN 0..* Identifier Payer Identification Number
Organization.Slices for identifier.identifier:PIN.Slices for extension Content/Rules for all slices
Organization.Slices for identifier.identifier:PIN.Slices for extension.extension:identifier-status 0..1 code NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
Organization.Slices for identifier.identifier:PIN.type 1..1 CodeableConcept Description of identifier
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "PAYERID"
    }
  ]
}
Organization.Slices for identifier.identifier:PIN.system 1..1 uri The namespace for the identifier value
Organization.Slices for identifier.identifier:PIN.value 1..1 string The value that is unique
Organization.active 1..1 boolean Whether the organization's record is still in active use
Fixed Value: true (no extensions allowed)
Organization.type This element must be supported. 1..1 CodeableConcept Kind of organization
Binding: Network Type Value Set (required)
Organization.name 1..1 string Name used for the organization
Organization.address
Organization.address.line 0..4 string Street name, number, direction & P.O. Box etc.
Organization.address.city 0..1 string Name of city, town etc.
Organization.address.state 0..1 string Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
Organization.address.postalCode 0..1 string US Zip Codes
Organization.address.country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Organization.partOf This element must be supported. 1..1 Reference(NDH Organization Profile) The organization that manages this network
Organization.contact 0..* BackboneElement Contact for the organization for a certain purpose
Organization.contact.name 0..1 HumanName A name associated with the contact
Organization.contact.telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
Organization.contact.address 0..1 Address Visiting or postal addresses for the contact
Organization.contact.address.state 0..1 string Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
Organization.endpoint This element must be supported. 0..* Reference(NDH Endpoint Profile) Technical endpoints providing access to services operated for the organization

doco 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 ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Organization C 0..* USCoreOrganizationProfile(6.1.0) A grouping of people or organizations with a common purpose
Constraints: org-1
Organization.id This element is included in summaries. 0..1 id Logical id of this artifact
Organization.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Organization.meta.id 0..1 string Unique id for inter-element referencing
Organization.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Organization.meta.lastUpdated This element is included in summaries. 1..1 instant When the resource version last changed
Organization.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Organization.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Organization.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Organization.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Organization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Organization.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Organization.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Organization.contained 0..* Resource Contained, inline Resources
Organization.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for extension.extension:location 0..* Reference(NDH Location Profile) Network coverage area
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference
Organization.Slices for extension.extension:organization-period 0..1 Period Valid time period for this Network
URL: http://hl7.org/fhir/StructureDefinition/organization-period
Organization.Slices for extension.extension:verification-status 0..1 CodeableConcept NDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
Organization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Organization.Slices for identifier This element must be supported. This element is included in summaries. C 0..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this, value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:All Slices Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.id 0..1 string Unique id for inter-element referencing
Organization.Slices for identifier.identifier:All Slices.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:All Slices.Slices for extension.extension:identifier-status 0..1 code NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
Organization.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Organization.Slices for identifier.identifier:All Slices.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
Organization.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Organization.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Organization.Slices for identifier.identifier:All Slices.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Organization.Slices for identifier.identifier:All Slices.assigner This element is included in summaries. 0..1 Reference(NDH Organization Profile) Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:NAIC This element is included in summaries. C 0..* Identifier NAIC Code
Constraints: us-core-19

Required Pattern:
{
  "system" : "urn:oid:2.16.840.1.113883.6.300"
}
Organization.Slices for identifier.identifier:PIN This element is included in summaries. C 0..* Identifier Payer Identification Number
Organization.Slices for identifier.identifier:PIN.id 0..1 string Unique id for inter-element referencing
Organization.Slices for identifier.identifier:PIN.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:PIN.Slices for extension Content/Rules for all slices
Organization.Slices for identifier.identifier:PIN.Slices for extension.extension:identifier-status 0..1 code NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
Organization.Slices for identifier.identifier:PIN.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:PIN.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "PAYERID"
    }
  ]
}
Organization.Slices for identifier.identifier:PIN.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Organization.Slices for identifier.identifier:PIN.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Organization.Slices for identifier.identifier:PIN.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Organization.Slices for identifier.identifier:PIN.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Organization.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether the organization's record is still in active use
Fixed Value: true (no extensions allowed)
Organization.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Kind of organization
Binding: Network Type Value Set (required)
Organization.name This element must be supported. This element is included in summaries. C 1..1 string Name used for the organization
Organization.alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
Organization.telecom This element must be supported. C 0..* ContactPoint A contact detail for the organization
Constraints: org-3
Organization.telecom.id 0..1 string Unique id for inter-element referencing
Organization.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.telecom.system This element must be supported. This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Organization.telecom.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
Organization.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Organization.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Organization.address This element must be supported. C 0..* Address An address for the organization
Constraints: org-2
Organization.address.id 0..1 string Unique id for inter-element referencing
Organization.address.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Organization.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Organization.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Organization.address.line This element must be supported. This element is included in summaries. 0..4 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Organization.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Organization.address.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Organization.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
Organization.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Organization.address.country This element must be supported. This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Organization.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Organization.partOf This element must be supported. This element is included in summaries. 1..1 Reference(NDH Organization Profile) The organization that manages this network
Organization.contact 0..* BackboneElement Contact for the organization for a certain purpose
Organization.contact.id 0..1 string Unique id for inter-element referencing
Organization.contact.extension 0..* Extension Additional content defined by implementations
Organization.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Organization.contact.purpose 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
Organization.contact.name 0..1 HumanName A name associated with the contact
Organization.contact.telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
Organization.contact.address 0..1 Address Visiting or postal addresses for the contact
Organization.contact.address.id 0..1 string Unique id for inter-element referencing
Organization.contact.address.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.contact.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Organization.contact.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Organization.contact.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Organization.contact.address.line This element is included in summaries. 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
Organization.contact.address.city This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Organization.contact.address.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Organization.contact.address.state This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
Organization.contact.address.postalCode This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
Organization.contact.address.country This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Organization.contact.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Organization.endpoint This element must be supported. 0..* Reference(NDH Endpoint Profile) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Organization.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Organization.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Organization.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Organization.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Organization.identifier:PIN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:PIN.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Organization.type Base 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.​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
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(4 nested mandatory elements)
Must-Support: 3 elements
Fixed: 1 element
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Search Parameters

Name Type Description Expression
active token

Is the Organization record active

Organization.active
address string

A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
NOTE : This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
Organization.address
address-city string

A city specified in an address

Organization.address.city
address-country string

A country specified in an address

Organization.address.country
address-postalcode string

A postal code specified in an address

Organization.address.postalCode
address-state string

A state specified in an address

Organization.address.state
address-use token

A use code specified in an address

Organization.address.use
coverage-area reference

Use this search parameter to find network records by coverage area to identify networks available in a specific location. Applies to Organization records.

Organization.extension.where(url='http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference').value.ofType(Reference)
endpoint reference

Select Organizations with the specified endpoint

Organization.endpoint
identifier token

Use this search parameter to support the :of-type modifier on Organization identifier searches. Applies to Organization records.

Organization.identifier
ihe-mcsd-purpose-of-use token

This SearchParameter enables finding Endpoints or Organizatoins by the purpose of use code. This resource is created as informative content.

(extension('https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.PurposeOfUse').value.ofType(CodeableConcept))
name string

Select Organizations with the specified name

Organization.name | Organization.alias
partof reference

An organization of which this organization forms a part

Organization.partOf
period date

Select Organization entries available during the specified period

Organization.extension.where(url='http://hl7.org/fhir/StructureDefinition/organization-period').value
phonetic string

A portion of the organization's name using some kind of phonetic matching algorithm

Organization.name
type token

A code for the type of organization

Organization.type
verification-status token

Use this search parameter to find records by verification standing to prioritize trusted and current directory data. Applies to Endpoint, HealthcareService, Organization, Location, Practitioner, PractitionerRole, InsurancePlan, OrganizationAffiliation, and Group records.

extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status').value

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