This page is part of the National Directory of Healthcare Providers and Services (NDH) Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndhPnQry-Network | Version: 1.0.0-ballot | |||
Active as of 2023-07-30 | Computable Name: NdhPnQryNetwork |
A Network refers to a healthcare provider insurance network. A healthcare provider insurance network is an aggregation of organizations and individuals that deliver a set of services across a geography through health insurance products/plans. In the NDH IG, individuals and organizations are represented as participants in a National Directory Query Network through the practitionerRole and National Directory Query-organizationAffiliation resources, respectively.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from NdhNetwork
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | 0..* | NdhNetwork | A grouping of people or organizations with a common purpose | |
extension:location | S | 0..* | LocationReference | NDH Location Reference |
value[x] | 1..1 | Reference(Payer Provider Network Query Location Profile) | Value of extension | |
identifier | 0..* | Identifier | Identifies this organization across multiple systems | |
type | S | 0..1 | CodeableConcept | Description of identifier |
assigner | S | 0..1 | Reference(Payer Provider Network Query Organization Profile) | Organization that issued id (may be just text) |
address | 0..1 | Address | An address for the organization | |
partOf | 1..1 | Reference(Payer Provider Network Query Organization Profile) | The organization that manages this network | |
contact | ||||
name | S | 0..1 | HumanName | A name associated with the contact |
telecom | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other |
value | S | 0..1 | string | The actual contact point details |
endpoint | 0..* | Reference(Payer Provider Network Query Endpoint Profile) | Technical endpoints providing access to services operated for the organization | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | NdhNetwork | A grouping of people or organizations with a common purpose |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
location | S | 0..* | Reference(NDH Base Location Profile) | NDH Location Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference" | |
value[x] | S | 1..1 | Reference(Payer Provider Network Query Location Profile) | Value of extension |
organization-period | 0..1 | Period | Valid time period for this Network URL: http://hl7.org/fhir/StructureDefinition/organization-period | |
usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |
verification-status | 0..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this |
identifier:All Slices | Content/Rules for all slices | |||
identifier-status | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | 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(Payer Provider Network Query Organization Profile) | Organization that issued id (may be just text) |
active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use Fixed Value: true |
type | SΣ | 1..1 | CodeableConcept | Kind of organization Binding: Network Type Value Set (required) |
name | SΣC | 1..1 | string | Name used for the organization |
telecom | SC | 0..* | ContactPoint | A contact detail for the organization |
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
value | SΣ | 0..1 | string | The actual contact point details |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
address | SC | 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(Payer Provider Network Query Organization Profile) | The organization that manages this network |
contact | 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) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | |
via-intermediary | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-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(Payer Provider Network Query Endpoint Profile) | Technical endpoints providing access to services operated for the organization |
Documentation for this format |
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..* | NdhNetwork | 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.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | C | 0..* | NdhRestriction | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
location | S | 0..* | Reference(NDH Base Location Profile) | NDH Location Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference" | |||||
value[x] | S | 1..1 | Reference(Payer Provider Network Query Location Profile) | Value of extension | ||||
organization-period | 0..1 | Period | Valid time period for this Network URL: http://hl7.org/fhir/StructureDefinition/organization-period | |||||
usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |||||
verification-status | 0..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this | ||||
identifier:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
identifier-status | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | 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(Payer Provider Network Query Organization Profile) | Organization that issued id (may be just text) | ||||
active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use Fixed Value: true | ||||
type | SΣ | 1..1 | CodeableConcept | Kind of organization Binding: Network Type Value Set (required) | ||||
name | SΣC | 1..1 | string | Name used for the organization | ||||
alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
telecom | SC | 0..* | ContactPoint | A contact detail 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 | |||||
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 | SC | 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(Payer Provider Network Query Organization Profile) | The organization that manages this network | ||||
contact | 0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
name | 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) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | |||||
via-intermediary | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-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(Payer Provider Network Query Endpoint Profile) | Technical endpoints providing access to services operated for the organization | ||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Organization.meta.security | extensible | All Security Labels | ||||
Organization.meta.tag | example | CommonTags | ||||
Organization.language | preferred | CommonLanguages
| ||||
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 NdhNetwork
Summary
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from NdhNetwork
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | 0..* | NdhNetwork | A grouping of people or organizations with a common purpose | |
extension:location | S | 0..* | LocationReference | NDH Location Reference |
value[x] | 1..1 | Reference(Payer Provider Network Query Location Profile) | Value of extension | |
identifier | 0..* | Identifier | Identifies this organization across multiple systems | |
type | S | 0..1 | CodeableConcept | Description of identifier |
assigner | S | 0..1 | Reference(Payer Provider Network Query Organization Profile) | Organization that issued id (may be just text) |
address | 0..1 | Address | An address for the organization | |
partOf | 1..1 | Reference(Payer Provider Network Query Organization Profile) | The organization that manages this network | |
contact | ||||
name | S | 0..1 | HumanName | A name associated with the contact |
telecom | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other |
value | S | 0..1 | string | The actual contact point details |
endpoint | 0..* | Reference(Payer Provider Network Query Endpoint Profile) | Technical endpoints providing access to services operated for the organization | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | NdhNetwork | A grouping of people or organizations with a common purpose |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
location | S | 0..* | Reference(NDH Base Location Profile) | NDH Location Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference" | |
value[x] | S | 1..1 | Reference(Payer Provider Network Query Location Profile) | Value of extension |
organization-period | 0..1 | Period | Valid time period for this Network URL: http://hl7.org/fhir/StructureDefinition/organization-period | |
usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |
verification-status | 0..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this |
identifier:All Slices | Content/Rules for all slices | |||
identifier-status | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | 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(Payer Provider Network Query Organization Profile) | Organization that issued id (may be just text) |
active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use Fixed Value: true |
type | SΣ | 1..1 | CodeableConcept | Kind of organization Binding: Network Type Value Set (required) |
name | SΣC | 1..1 | string | Name used for the organization |
telecom | SC | 0..* | ContactPoint | A contact detail for the organization |
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
value | SΣ | 0..1 | string | The actual contact point details |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
address | SC | 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(Payer Provider Network Query Organization Profile) | The organization that manages this network |
contact | 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) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | |
via-intermediary | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-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(Payer Provider Network Query Endpoint Profile) | Technical endpoints providing access to services operated for the organization |
Documentation for this format |
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..* | NdhNetwork | 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.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | C | 0..* | NdhRestriction | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
location | S | 0..* | Reference(NDH Base Location Profile) | NDH Location Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference" | |||||
value[x] | S | 1..1 | Reference(Payer Provider Network Query Location Profile) | Value of extension | ||||
organization-period | 0..1 | Period | Valid time period for this Network URL: http://hl7.org/fhir/StructureDefinition/organization-period | |||||
usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |||||
verification-status | 0..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this | ||||
identifier:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
identifier-status | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | 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(Payer Provider Network Query Organization Profile) | Organization that issued id (may be just text) | ||||
active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use Fixed Value: true | ||||
type | SΣ | 1..1 | CodeableConcept | Kind of organization Binding: Network Type Value Set (required) | ||||
name | SΣC | 1..1 | string | Name used for the organization | ||||
alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
telecom | SC | 0..* | ContactPoint | A contact detail 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 | |||||
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 | SC | 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(Payer Provider Network Query Organization Profile) | The organization that manages this network | ||||
contact | 0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
name | 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) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | |||||
via-intermediary | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-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(Payer Provider Network Query Endpoint Profile) | Technical endpoints providing access to services operated for the organization | ||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Organization.meta.security | extensible | All Security Labels | ||||
Organization.meta.tag | example | CommonTags | ||||
Organization.language | preferred | CommonLanguages
| ||||
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 NdhNetwork
Summary
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron