National Healthcare Directory Query
1.0.0-ballot - ballot

National Healthcare Directory Query, published by HL7 International - Patient Administration Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0-ballot). This version is based on the current content of https://github.com/HL7/fhir-directory-query/ and changes regularly. See the Directory of published versions

## Resource Profile: National Directory Endpoint Qry Exchange Network

Official URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-Network | Version: 1.0.0-ballot
Active as of 2022-12-08 | Computable Name: NatlDirEndpointQryNetwork

A Network refers to a healthcare provider insurance network. A healthcare provider insurance network is an aggregation of organizations and individuals that deliver a set of services across a geography through health insurance products/plans. A network is typically owned by a payer.

In the NatlDir IG, individuals and organizations are represented as participants in a National Directory Exchange Network through the practitionerRole and National Directory Exchange-organizationAffiliation resources, respectively.

Usage:

- Refer to this Resource Profile:
- Examples for this Resource Profile: ACME CT Premium Preferred Provider Network, ACME CT Preferred Provider Network

### Formal Views of Profile Content

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

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from USCoreOrganizationProfile

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Organization |  | 0..* | USCoreOrganizationProfile | A grouping of people or organizations with a common purpose
meta |  |  |  |
lastUpdated |  | 1..1 | instant | When the resource version last changed
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
location-reference | S | 0..* | Reference(National Directory Endpoint Qry Exchange Location) | Network coverage area URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/location-reference
identifier |  | 0..* | Identifier | Identifies this organization across multiple systems
type | S | 0..1 | CodeableConcept | Description of identifier
assigner | S | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
active |  | 1..1 | boolean | Whether the organization's record is still in active use Fixed Value: true
type | S | 1..1 | CodeableConcept | Kind of organization Binding: Network Type Value Set (required)
telecom |  | 0..0 |  |
address |  | 0..1 | Address | An address for the organization
partOf | S | 1..1 | Reference(National Directory Endpoint Qry Exchange Organization) | The organization that manages this network
contact | S | 0..* | BackboneElement | Contact for the organization for a certain purpose
name | S | 0..1 | HumanName | A name associated with the contact
telecom | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact
contactpoint-availabletime |  | 0..* | (Complex) | Contactpoint Availabletime URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
via-intermediary |  | 0..* | Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization) | Via Intermediary URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other
value | S | 0..1 | string | The actual contact point details
endpoint | S | 0..* | Reference(National Directory Endpoint Qry Exchange Endpoint) | Technical endpoints providing access to services operated for the organization
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
Organization.type | required | NetworkTypeVS

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Organization | C | 0..* | USCoreOrganizationProfile | A grouping of people or organizations with a common purpose
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
location-reference | S | 0..* | Reference(National Directory Endpoint Qry Exchange Location) | Network coverage area URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/location-reference
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ C | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this
identifier:All Slices |  |  |  | Content/Rules for all slices
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | S Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 0..1 | string | The value that is unique Example General: 123456
assigner | S Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:NPI | S Σ C | 0..1 | Identifier | National Provider Identifier (NPI) Required Pattern: At least the following
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
identifier:CLIA | Σ C | 0..1 | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Required Pattern: At least the following
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7
active | ?!S Σ | 1..1 | boolean | Whether the organization's record is still in active use Fixed Value: true
type | S Σ | 1..1 | CodeableConcept | Kind of organization Binding: Network Type Value Set (required)
name | S Σ C | 1..1 | string | Name used for the organization
address | S C | 0..1 | Address | An address for the organization
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
line | S Σ | 0..4 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
country | S Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
partOf | S Σ | 1..1 | Reference(National Directory Endpoint Qry Exchange Organization) | The organization that manages this network
contact | S | 0..* | BackboneElement | Contact for the organization for a certain purpose
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S | 0..1 | HumanName | A name associated with the contact
telecom | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact
contactpoint-availabletime |  | 0..* | (Complex) | Contactpoint Availabletime URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
via-intermediary |  | 0..* | Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization) | Via Intermediary URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
system | S Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 0..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
endpoint | S | 0..* | Reference(National Directory Endpoint Qry Exchange Endpoint) | Technical endpoints providing access to services operated for the organization
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
Organization.identifier.use | required | IdentifierUse
Organization.identifier.type | extensible | Identifier Type Codes
Organization.type | required | NetworkTypeVS
Organization.telecom.system | required | ContactPointSystem
Organization.telecom.use | required | ContactPointUse
Organization.address.use | required | AddressUse
Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from `https://www.usps.com/`)
Organization.contact.telecom.system | required | ContactPointSystem
Organization.contact.telecom.use | required | ContactPointUse

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Organization | C | 0..* | USCoreOrganizationProfile | A grouping of people or organizations with a common purpose
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 1..1 | instant | When the resource version last changed
source | Σ | 0..1 | uri | Identifies where the resource comes from
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
location-reference | S | 0..* | Reference(National Directory Endpoint Qry Exchange Location) | Network coverage area URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/location-reference
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ C | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this
identifier:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | S Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 0..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | S Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:NPI | S Σ C | 0..1 | Identifier | National Provider Identifier (NPI) Required Pattern: At least the following
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 0..1 | CodeableConcept | Description of identifier
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
value |  | 0..1 | string | The value that is unique
period |  | 0..1 | Period | Time period when id is/was valid for use
assigner |  | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:CLIA | Σ C | 0..1 | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Required Pattern: At least the following
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 0..1 | CodeableConcept | Description of identifier
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7
value |  | 0..1 | string | The value that is unique
period |  | 0..1 | Period | Time period when id is/was valid for use
assigner |  | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
active | ?!S Σ | 1..1 | boolean | Whether the organization's record is still in active use Fixed Value: true
type | S Σ | 1..1 | CodeableConcept | Kind of organization Binding: Network Type Value Set (required)
name | S Σ C | 1..1 | string | Name used for the organization
alias |  | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past
address | S C | 0..1 | Address | An address for the organization
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | S Σ | 0..4 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
country | S Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
partOf | S Σ | 1..1 | Reference(National Directory Endpoint Qry Exchange Organization) | The organization that manages this network
contact | S | 0..* | BackboneElement | Contact for the organization for a certain purpose
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
purpose |  | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
name | S | 0..1 | HumanName | A name associated with the contact
telecom | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
contactpoint-availabletime |  | 0..* | (Complex) | Contactpoint Availabletime URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
via-intermediary |  | 0..* | Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization) | Via Intermediary URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
system | S Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 0..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
address |  | 0..1 | Address | Visiting or postal addresses for the contact
endpoint | S | 0..* | Reference(National Directory Endpoint Qry Exchange Endpoint) | Technical endpoints providing access to services operated for the organization
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
Organization.meta.security | extensible | All Security Labels
Organization.meta.tag | example | CommonTags
Organization.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
Organization.identifier.use | required | IdentifierUse
Organization.identifier.type | extensible | Identifier Type Codes
Organization.type | required | NetworkTypeVS
Organization.telecom.system | required | ContactPointSystem
Organization.telecom.use | required | ContactPointUse
Organization.address.use | required | AddressUse
Organization.address.type | required | AddressType
Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from `https://www.usps.com/`)
Organization.contact.purpose | extensible | ContactEntityType
Organization.contact.telecom.system | required | ContactPointSystem
Organization.contact.telecom.use | required | ContactPointUse

This structure is derived from USCoreOrganizationProfile

Summary

Mandatory: 2 elements (1 nested mandatory element)
Must-Support: 11 elements
Fixed Value: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

- National Directory Endpoint Qry Exchange Organization (http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-Organization)
- National Directory Endpoint Qry Exchange Endpoint (http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-Endpoint)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/directory-query/StructureDefinition/location-reference
- http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
- http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary

Differential View

This structure is derived from USCoreOrganizationProfile

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Organization |  | 0..* | USCoreOrganizationProfile | A grouping of people or organizations with a common purpose
meta |  |  |  |
lastUpdated |  | 1..1 | instant | When the resource version last changed
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
location-reference | S | 0..* | Reference(National Directory Endpoint Qry Exchange Location) | Network coverage area URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/location-reference
identifier |  | 0..* | Identifier | Identifies this organization across multiple systems
type | S | 0..1 | CodeableConcept | Description of identifier
assigner | S | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
active |  | 1..1 | boolean | Whether the organization's record is still in active use Fixed Value: true
type | S | 1..1 | CodeableConcept | Kind of organization Binding: Network Type Value Set (required)
telecom |  | 0..0 |  |
address |  | 0..1 | Address | An address for the organization
partOf | S | 1..1 | Reference(National Directory Endpoint Qry Exchange Organization) | The organization that manages this network
contact | S | 0..* | BackboneElement | Contact for the organization for a certain purpose
name | S | 0..1 | HumanName | A name associated with the contact
telecom | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact
contactpoint-availabletime |  | 0..* | (Complex) | Contactpoint Availabletime URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
via-intermediary |  | 0..* | Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization) | Via Intermediary URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other
value | S | 0..1 | string | The actual contact point details
endpoint | S | 0..* | Reference(National Directory Endpoint Qry Exchange Endpoint) | Technical endpoints providing access to services operated for the organization
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
Organization.type | required | NetworkTypeVS

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Organization | C | 0..* | USCoreOrganizationProfile | A grouping of people or organizations with a common purpose
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
location-reference | S | 0..* | Reference(National Directory Endpoint Qry Exchange Location) | Network coverage area URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/location-reference
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ C | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this
identifier:All Slices |  |  |  | Content/Rules for all slices
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | S Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 0..1 | string | The value that is unique Example General: 123456
assigner | S Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:NPI | S Σ C | 0..1 | Identifier | National Provider Identifier (NPI) Required Pattern: At least the following
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
identifier:CLIA | Σ C | 0..1 | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Required Pattern: At least the following
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7
active | ?!S Σ | 1..1 | boolean | Whether the organization's record is still in active use Fixed Value: true
type | S Σ | 1..1 | CodeableConcept | Kind of organization Binding: Network Type Value Set (required)
name | S Σ C | 1..1 | string | Name used for the organization
address | S C | 0..1 | Address | An address for the organization
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
line | S Σ | 0..4 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
country | S Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
partOf | S Σ | 1..1 | Reference(National Directory Endpoint Qry Exchange Organization) | The organization that manages this network
contact | S | 0..* | BackboneElement | Contact for the organization for a certain purpose
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S | 0..1 | HumanName | A name associated with the contact
telecom | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact
contactpoint-availabletime |  | 0..* | (Complex) | Contactpoint Availabletime URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
via-intermediary |  | 0..* | Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization) | Via Intermediary URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
system | S Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 0..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
endpoint | S | 0..* | Reference(National Directory Endpoint Qry Exchange Endpoint) | Technical endpoints providing access to services operated for the organization
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
Organization.identifier.use | required | IdentifierUse
Organization.identifier.type | extensible | Identifier Type Codes
Organization.type | required | NetworkTypeVS
Organization.telecom.system | required | ContactPointSystem
Organization.telecom.use | required | ContactPointUse
Organization.address.use | required | AddressUse
Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from `https://www.usps.com/`)
Organization.contact.telecom.system | required | ContactPointSystem
Organization.contact.telecom.use | required | ContactPointUse

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Organization | C | 0..* | USCoreOrganizationProfile | A grouping of people or organizations with a common purpose
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 1..1 | instant | When the resource version last changed
source | Σ | 0..1 | uri | Identifies where the resource comes from
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
location-reference | S | 0..* | Reference(National Directory Endpoint Qry Exchange Location) | Network coverage area URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/location-reference
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ C | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this
identifier:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | S Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 0..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | S Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:NPI | S Σ C | 0..1 | Identifier | National Provider Identifier (NPI) Required Pattern: At least the following
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 0..1 | CodeableConcept | Description of identifier
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
value |  | 0..1 | string | The value that is unique
period |  | 0..1 | Period | Time period when id is/was valid for use
assigner |  | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:CLIA | Σ C | 0..1 | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Required Pattern: At least the following
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 0..1 | CodeableConcept | Description of identifier
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7
value |  | 0..1 | string | The value that is unique
period |  | 0..1 | Period | Time period when id is/was valid for use
assigner |  | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
active | ?!S Σ | 1..1 | boolean | Whether the organization's record is still in active use Fixed Value: true
type | S Σ | 1..1 | CodeableConcept | Kind of organization Binding: Network Type Value Set (required)
name | S Σ C | 1..1 | string | Name used for the organization
alias |  | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past
address | S C | 0..1 | Address | An address for the organization
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | S Σ | 0..4 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
country | S Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
partOf | S Σ | 1..1 | Reference(National Directory Endpoint Qry Exchange Organization) | The organization that manages this network
contact | S | 0..* | BackboneElement | Contact for the organization for a certain purpose
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
purpose |  | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
name | S | 0..1 | HumanName | A name associated with the contact
telecom | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
contactpoint-availabletime |  | 0..* | (Complex) | Contactpoint Availabletime URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
via-intermediary |  | 0..* | Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization) | Via Intermediary URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
system | S Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 0..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
address |  | 0..1 | Address | Visiting or postal addresses for the contact
endpoint | S | 0..* | Reference(National Directory Endpoint Qry Exchange Endpoint) | Technical endpoints providing access to services operated for the organization
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
Organization.meta.security | extensible | All Security Labels
Organization.meta.tag | example | CommonTags
Organization.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
Organization.identifier.use | required | IdentifierUse
Organization.identifier.type | extensible | Identifier Type Codes
Organization.type | required | NetworkTypeVS
Organization.telecom.system | required | ContactPointSystem
Organization.telecom.use | required | ContactPointUse
Organization.address.use | required | AddressUse
Organization.address.type | required | AddressType
Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from `https://www.usps.com/`)
Organization.contact.purpose | extensible | ContactEntityType
Organization.contact.telecom.system | required | ContactPointSystem
Organization.contact.telecom.use | required | ContactPointUse

This structure is derived from USCoreOrganizationProfile

Summary

Mandatory: 2 elements (1 nested mandatory element)
Must-Support: 11 elements
Fixed Value: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

- National Directory Endpoint Qry Exchange Organization (http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-Organization)
- National Directory Endpoint Qry Exchange Endpoint (http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-Endpoint)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/directory-query/StructureDefinition/location-reference
- http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
- http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary

Other representations of profile: CSV, Excel, Schematron