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
| 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.999.1.2.3.4.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.
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.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | USCoreOrganizationProfile(6.1.0) | A grouping of people or organizations with a common purpose Constraints: org-1 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..* | Reference(NDH Location Profile) | Network coverage area URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference | |
![]() ![]() ![]() |
0..1 | Period | Valid time period for this Network URL: http://hl7.org/fhir/StructureDefinition/organization-period | |
![]() ![]() ![]() |
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) | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
ΣC | 0..* | Identifier | NAIC Code Constraints: us-core-19 Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.300 | |
![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
![]() ![]() |
?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use Fixed Value: true |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Kind of organization Binding: Network Type Value Set (required) |
![]() ![]() |
SΣC | 1..1 | string | Name used for the organization |
![]() ![]() |
SC | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3 |
![]() ![]() ![]() |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() |
SΣ | 0..1 | string | The actual contact point details |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() |
SC | 0..* | Address | An address for the organization Constraints: org-2 |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible) |
![]() ![]() ![]() |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 |
![]() ![]() ![]() |
SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
![]() ![]() |
SΣ | 1..1 | Reference(NDH Organization Profile) | The organization that manages this network |
![]() ![]() |
0..* | BackboneElement | Contact for the organization for a certain purpose | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact | |
![]() ![]() ![]() |
0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
![]() ![]() ![]() |
0..1 | Address | Visiting or postal addresses for the contact | |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible) |
![]() ![]() |
S | 0..* | Reference(NDH Endpoint Profile) | Technical endpoints providing access to services operated for the organization |
Documentation for this format | ||||
| 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 |
| 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 |
| 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}$')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | USCoreOrganizationProfile(6.1.0) | A grouping of people or organizations with a common purpose | |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | instant | When the resource version last changed | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..* | Reference(NDH Location Profile) | Network coverage area URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference | |
![]() ![]() ![]() |
0..1 | Period | Valid time period for this Network URL: http://hl7.org/fhir/StructureDefinition/organization-period | |
![]() ![]() ![]() |
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) | |
![]() ![]() |
0..* | Identifier | Identifies this organization across multiple systems | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |
![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | |
![]() ![]() ![]() |
0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text) | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..0 | National Provider Identifier (NPI) | ||
![]() ![]() ![]() |
0..0 | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories | ||
![]() ![]() |
1..1 | boolean | Whether the organization's record is still in active use Fixed Value: true | |
![]() ![]() |
S | 1..1 | CodeableConcept | Kind of organization Binding: Network Type Value Set (required) |
![]() ![]() |
1..1 | string | Name used for the organization | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..4 | string | Street name, number, direction & P.O. Box etc. | |
![]() ![]() ![]() |
0..1 | string | Name of city, town etc. | |
![]() ![]() ![]() |
0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible) | |
![]() ![]() ![]() |
0..1 | string | US Zip Codes | |
![]() ![]() ![]() |
0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |
![]() ![]() |
S | 1..1 | Reference(NDH Organization Profile) | The organization that manages this network |
![]() ![]() |
0..* | BackboneElement | Contact for the organization for a certain purpose | |
![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact | |
![]() ![]() ![]() |
0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
![]() ![]() ![]() |
0..1 | Address | Visiting or postal addresses for the contact | |
![]() ![]() ![]() ![]() |
0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible) | |
![]() ![]() |
S | 0..* | Reference(NDH Endpoint Profile) | Technical endpoints providing access to services operated for the organization |
Documentation for this format | ||||
| 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: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | USCoreOrganizationProfile(6.1.0) | A grouping of people or organizations with a common purpose Constraints: org-1 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 1..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | Reference(NDH Location Profile) | Network coverage area URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference | |||||
![]() ![]() ![]() |
0..1 | Period | Valid time period for this Network URL: http://hl7.org/fhir/StructureDefinition/organization-period | |||||
![]() ![]() ![]() |
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) | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
ΣC | 0..* | Identifier | NAIC Code Constraints: us-core-19 Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.300 | |||||
![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() |
?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use Fixed Value: true | ||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Kind of organization Binding: Network Type Value Set (required) | ||||
![]() ![]() |
SΣC | 1..1 | string | Name used for the organization | ||||
![]() ![]() |
0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
![]() ![]() |
SC | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() |
SC | 0..* | Address | An address for the organization Constraints: org-2 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() |
SΣ | 1..1 | Reference(NDH Organization Profile) | The organization that manages this network | ||||
![]() ![]() |
0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact | |||||
![]() ![]() ![]() |
0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
![]() ![]() ![]() |
0..1 | Address | Visiting or postal addresses for the contact | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() |
S | 0..* | Reference(NDH Endpoint Profile) | Technical endpoints providing access to services operated for the organization | ||||
Documentation for this format | ||||||||
| 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.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 |
| 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}$')
|
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:
Extensions
This structure refers to these extensions:
Maturity: 4
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | USCoreOrganizationProfile(6.1.0) | A grouping of people or organizations with a common purpose Constraints: org-1 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..* | Reference(NDH Location Profile) | Network coverage area URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference | |
![]() ![]() ![]() |
0..1 | Period | Valid time period for this Network URL: http://hl7.org/fhir/StructureDefinition/organization-period | |
![]() ![]() ![]() |
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) | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
ΣC | 0..* | Identifier | NAIC Code Constraints: us-core-19 Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.300 | |
![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
![]() ![]() |
?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use Fixed Value: true |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Kind of organization Binding: Network Type Value Set (required) |
![]() ![]() |
SΣC | 1..1 | string | Name used for the organization |
![]() ![]() |
SC | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3 |
![]() ![]() ![]() |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() |
SΣ | 0..1 | string | The actual contact point details |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() |
SC | 0..* | Address | An address for the organization Constraints: org-2 |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible) |
![]() ![]() ![]() |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 |
![]() ![]() ![]() |
SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
![]() ![]() |
SΣ | 1..1 | Reference(NDH Organization Profile) | The organization that manages this network |
![]() ![]() |
0..* | BackboneElement | Contact for the organization for a certain purpose | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact | |
![]() ![]() ![]() |
0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
![]() ![]() ![]() |
0..1 | Address | Visiting or postal addresses for the contact | |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible) |
![]() ![]() |
S | 0..* | Reference(NDH Endpoint Profile) | Technical endpoints providing access to services operated for the organization |
Documentation for this format | ||||
| 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 |
| 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 |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | USCoreOrganizationProfile(6.1.0) | A grouping of people or organizations with a common purpose | |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | instant | When the resource version last changed | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..* | Reference(NDH Location Profile) | Network coverage area URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference | |
![]() ![]() ![]() |
0..1 | Period | Valid time period for this Network URL: http://hl7.org/fhir/StructureDefinition/organization-period | |
![]() ![]() ![]() |
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) | |
![]() ![]() |
0..* | Identifier | Identifies this organization across multiple systems | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |
![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | |
![]() ![]() ![]() |
0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text) | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..0 | National Provider Identifier (NPI) | ||
![]() ![]() ![]() |
0..0 | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories | ||
![]() ![]() |
1..1 | boolean | Whether the organization's record is still in active use Fixed Value: true | |
![]() ![]() |
S | 1..1 | CodeableConcept | Kind of organization Binding: Network Type Value Set (required) |
![]() ![]() |
1..1 | string | Name used for the organization | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..4 | string | Street name, number, direction & P.O. Box etc. | |
![]() ![]() ![]() |
0..1 | string | Name of city, town etc. | |
![]() ![]() ![]() |
0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible) | |
![]() ![]() ![]() |
0..1 | string | US Zip Codes | |
![]() ![]() ![]() |
0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |
![]() ![]() |
S | 1..1 | Reference(NDH Organization Profile) | The organization that manages this network |
![]() ![]() |
0..* | BackboneElement | Contact for the organization for a certain purpose | |
![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact | |
![]() ![]() ![]() |
0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
![]() ![]() ![]() |
0..1 | Address | Visiting or postal addresses for the contact | |
![]() ![]() ![]() ![]() |
0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible) | |
![]() ![]() |
S | 0..* | Reference(NDH Endpoint Profile) | Technical endpoints providing access to services operated for the organization |
Documentation for this format | ||||
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | USCoreOrganizationProfile(6.1.0) | A grouping of people or organizations with a common purpose Constraints: org-1 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 1..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | Reference(NDH Location Profile) | Network coverage area URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference | |||||
![]() ![]() ![]() |
0..1 | Period | Valid time period for this Network URL: http://hl7.org/fhir/StructureDefinition/organization-period | |||||
![]() ![]() ![]() |
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) | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
ΣC | 0..* | Identifier | NAIC Code Constraints: us-core-19 Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.300 | |||||
![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() |
?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use Fixed Value: true | ||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Kind of organization Binding: Network Type Value Set (required) | ||||
![]() ![]() |
SΣC | 1..1 | string | Name used for the organization | ||||
![]() ![]() |
0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
![]() ![]() |
SC | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() |
SC | 0..* | Address | An address for the organization Constraints: org-2 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() |
SΣ | 1..1 | Reference(NDH Organization Profile) | The organization that manages this network | ||||
![]() ![]() |
0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact | |||||
![]() ![]() ![]() |
0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
![]() ![]() ![]() |
0..1 | Address | Visiting or postal addresses for the contact | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() |
S | 0..* | Reference(NDH Endpoint Profile) | Technical endpoints providing access to services operated for the organization | ||||
Documentation for this format | ||||||||
| 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.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 |
| 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}$')
|
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:
Extensions
This structure refers to these extensions:
Maturity: 4
Other representations of profile: CSV, Excel, Schematron
| 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
|
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 |
Technical endpoints providing access to services operated for the organization |
Organization.endpoint
|
| identifier | token |
Any identifier for the organization (not the accreditation issuer's identifier) |
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 |
A portion of the organization's name or alias
|
Organization.name|Organization.alias
|
| partof | reference |
Select Organizations that are part of the specified organization |
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 |
Select Organizations of the specified type |
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 | Example |
|---|---|
| Organization:coverage-area | GET [base]/Organization?type=ntwk&_include=Organization:coverage-area |
| _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 |