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 1.0.0-ballot 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-ndapi-Organization | Version: 1.0.0-ballot | |||
Active as of 2024-09-11 | Computable Name: NdhNdApiOrganization |
An organization is a formal or informal grouping of people or organizations with a common purpose, such as a company, institution, corporation, community group, or healthcare practice. Guidance: When the contact is a department name, rather than a human (e.g., patient help line), include a blank family and given name, and provide the department name in contact.name.text
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from NdhOrganization
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | NdhOrganization | |||
meta | S | 0..1 | Meta | Metadata about the resource |
profile | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
extension | 1..* | Extension | Extension | |
Slices for extension | Content/Rules for all slices | |||
extension:org-description | S | 0..1 | OrgDescription | NDH Org Description |
extension:digitalcertificate | S | 0..* | Digitalcertificate | NDH Digitalcertificate |
extension:qualification | S | 0..* | Qualification | NDH Qualification |
extension:insuranceplan | S | 0..* | InsurancePlanReference | NDH InsurancePlan Reference |
value[x] | 1..1 | Reference(National Directory API InsurancePlan Profile) | Value of extension | |
extension:verification-status | S | 1..1 | VerificationStatus | NDH Verification Status |
identifier | 0..* | Identifier | Identifies this organization across multiple systems | |
extension | 1..* | Extension | Extension | |
Slices for extension | Content/Rules for all slices | |||
extension:identifier-status | S | 1..1 | IdentifierStatus | NDH Identifier Status |
use | S | 0..1 | code | usual | official | temp | secondary | old (If known) |
type | S | 0..1 | CodeableConcept | Description of identifier |
assigner | S | 0..1 | Reference(National Directory API Organization Profile) | Organization that issued id (may be just text) |
alias | ||||
Slices for extension | Content/Rules for all slices | |||
extension:org-alias-type | S | 0..1 | OrgAliasType | NDH Organization Alias Type |
extension:org-alias-period | S | 0..1 | OrgAliasPeriod | NDH Organization Alias Period |
telecom | ||||
Slices for extension | Content/Rules for all slices | |||
extension:contactpoint-availabletime | S | 0..* | ContactPointAvailableTime | NDH Contactpoint Availabletime |
extension:via-intermediary | S | 0..1 | ViaIntermediary | NDH Via Intermediary |
use | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
rank | S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
address | ||||
Slices for extension | Content/Rules for all slices | |||
extension:geolocation | S | 0..1 | Geolocation(4.0.1) | The absolute geographic location |
use | S | 0..1 | code | home | work | temp | old | billing - purpose of this address |
type | S | 0..1 | code | postal | physical | both |
text | S | 0..1 | string | Text representation of the address |
partOf | S | 0..1 | Reference(National Directory API Organization Profile) | The organization of which this organization forms a part |
contact | S | 0..* | BackboneElement | Contact for the organization for a certain purpose |
purpose | S | 0..1 | CodeableConcept | The type of contact |
name | S | 0..1 | HumanName | A name associated with the contact |
use | S | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden |
text | S | 0..1 | string | Text representation of the full name |
family | S | 0..1 | string | Family name (often called 'Surname') |
given | S | 0..* | string | Given names (not always 'first'). Includes middle names |
prefix | S | 0..* | string | Parts that come before the name |
suffix | S | 0..* | string | Parts that come after the name |
period | S | 0..1 | Period | Time period when name was/is in use |
telecom | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
Slices for extension | Content/Rules for all slices | |||
extension:contactpoint-availabletime | S | 0..* | ContactPointAvailableTime | NDH Contactpoint Availabletime |
extension:via-intermediary | S | 0..1 | ViaIntermediary | NDH Via Intermediary |
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other |
value | S | 0..1 | string | The actual contact point details |
use | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
rank | S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
address | S | 0..1 | Address | Visiting or postal addresses for the contact |
use | S | 0..1 | code | home | work | temp | old | billing - purpose of this address |
type | S | 0..1 | code | postal | physical | both |
text | S | 0..1 | string | Text representation of the address |
line | S | 0..* | string | Street name, number, direction & P.O. Box etc. |
city | S | 0..1 | string | Name of city, town etc. |
state | S | 0..1 | string | Sub-unit of country (abbreviations ok) |
postalCode | S | 0..1 | string | Postal code for area |
country | S | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
endpoint | 0..* | Reference(National Directory API 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..* | NdhOrganization | A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one |
meta | SΣ | 0..1 | Meta | Metadata about the resource |
lastUpdated | Σ | 1..1 | instant | When the resource version last changed |
profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
rating | 0..* | (Complex) | NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating | |
paymentaccepted | 0..* | CodeableConcept | NDH Payment Accepted URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: hl7VS-paymentMethodCode (required) | |
fundingSource | 0..* | (Complex) | NDH Funding Source URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource | |
org-description | S | 0..1 | string | NDH Org Description URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-description |
digitalcertificate | S | 0..* | (Complex) | NDH Digitalcertificate URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate |
qualification | S | 0..* | (Complex) | NDH Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification |
usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |
insuranceplan | S | 0..* | (Complex) | NDH InsurancePlan Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-insuranceplan-reference |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-insuranceplan-reference" | |
value[x] | S | 1..1 | Reference(National Directory API InsurancePlan Profile) | Value of extension |
verification-status | S | 1..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) |
logo | 0..1 | Attachment | NDH Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this |
identifier:All Slices | Content/Rules for all slices | |||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
identifier-status | S | 1..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) |
use | ?!SΣ | 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(National Directory API Organization Profile) | Organization that issued id (may be just text) |
identifier:NPI | SΣC | 0..* | Identifier | National Provider Identifier (NPI) us-core-16: NPI must be 10 digits us-core-17: NPI check digit must be valid (Luhn algorithm check) 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..* | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories us-core-18: CLIA number must be 10 digits with a letter "D" in third position 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 | |
identifier:NAIC | ΣC | 0..* | Identifier | NAIC Code us-core-19: NAIC must be 5 digits 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.6.300 | |
identifier:TID | SΣC | 0..1 | Identifier | Tax Identifier Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org.fhir/sid/us-ssn | |
active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use Required Pattern: true |
type | SΣ | 1..* | CodeableConcept | Kind of organization Binding: Organization Type Value Set (extensible) |
name | SΣC | 1..1 | string | Name used for the organization |
alias | S | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past |
Slices for extension | Content/Rules for all slices | |||
org-alias-type | S | 0..1 | CodeableConcept | NDH Organization Alias Type URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-type Binding: Organization Alias Type Value Sete (example) |
org-alias-period | S | 0..1 | Period | NDH Organization Alias Period URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-period |
telecom | SC | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' |
Slices for extension | Content/Rules for all slices | |||
contactpoint-availabletime | S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime |
via-intermediary | S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary |
language-speak | 0..* | code | Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible) | |
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 | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
rank | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
address | SC | 0..* | Address | An address for the organization org-2: An address of an organization can never be of use 'home' |
Slices for extension | Content/Rules for all slices | |||
geolocation | S | 0..1 | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation |
use | ?!SΣ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
type | SΣ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
text | SΣ | 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 |
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Σ | 0..1 | Reference(National Directory API Organization Profile) | The organization of which this organization forms a part |
contact | S | 0..* | BackboneElement | Contact for the organization for a certain purpose |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
purpose | S | 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 |
use | ?!SΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
text | SΣ | 0..1 | string | Text representation of the full name |
family | SΣ | 0..1 | string | Family name (often called 'Surname') |
given | SΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
prefix | SΣ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
suffix | SΣ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
period | SΣ | 0..1 | Period | Time period when name was/is in use |
telecom | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
Slices for extension | Content/Rules for all slices | |||
contactpoint-availabletime | S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime |
via-intermediary | S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH 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 | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
rank | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
address | S | 0..1 | Address | Visiting or postal addresses for the contact |
use | ?!SΣ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
type | SΣ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
text | SΣ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
line | SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) |
postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 |
country | SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
endpoint | S | 0..* | Reference(National Directory API Endpoint Profile) | Technical endpoints providing access to services operated for the organization |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Organization.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Organization.type | extensible | OrgTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/OrgTypeVS from this IG | |
Organization.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Organization.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Organization.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Organization.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | |
Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/ )http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state | |
Organization.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-type from the FHIR Standard | |
Organization.contact.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Organization.contact.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Organization.contact.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Organization.contact.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Organization.contact.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
us-core-16 | error | Organization.identifier:NPI | NPI must be 10 digits : value.matches('^[0-9]{10}$') | |
us-core-17 | error | Organization.identifier:NPI | NPI check digit must be valid (Luhn algorithm check) : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0) | |
us-core-18 | error | Organization.identifier:CLIA | CLIA number must be 10 digits with a letter "D" in third position : value.matches('^[0-9]{2}D[0-9]{7}$') | |
us-core-19 | error | Organization.identifier:NAIC | NAIC must be 5 digits : value.matches('^[0-9]{5}$') |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Organization | C | 0..* | NdhOrganization | A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | SΣ | 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 | Σ | 1..1 | 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 | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
rating | 0..* | (Complex) | NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating | |||||
paymentaccepted | 0..* | CodeableConcept | NDH Payment Accepted URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: hl7VS-paymentMethodCode (required) | |||||
fundingSource | 0..* | (Complex) | NDH Funding Source URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource | |||||
org-description | S | 0..1 | string | NDH Org Description URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-description | ||||
digitalcertificate | S | 0..* | (Complex) | NDH Digitalcertificate URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate | ||||
qualification | S | 0..* | (Complex) | NDH Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification | ||||
usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |||||
insuranceplan | S | 0..* | (Complex) | NDH InsurancePlan Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-insuranceplan-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-insuranceplan-reference" | |||||
value[x] | S | 1..1 | Reference(National Directory API InsurancePlan Profile) | Value of extension | ||||
verification-status | S | 1..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | ||||
logo | 0..1 | Attachment | NDH Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo | |||||
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 | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
identifier-status | S | 1..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | ||||
use | ?!SΣ | 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(National Directory API Organization Profile) | Organization that issued id (may be just text) | ||||
identifier:NPI | SΣC | 0..* | Identifier | National Provider Identifier (NPI) us-core-16: NPI must be 10 digits us-core-17: NPI check digit must be valid (Luhn algorithm check) Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: 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..* | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories us-core-18: CLIA number must be 10 digits with a letter "D" in third position Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.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) | |||||
identifier:NAIC | ΣC | 0..* | Identifier | NAIC Code us-core-19: NAIC must be 5 digits Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.300 | |||||
value | 0..1 | string | The value that is unique | |||||
period | 0..1 | Period | Time period when id is/was valid for use | |||||
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
identifier:TID | SΣC | 0..1 | Identifier | Tax Identifier Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org.fhir/sid/us-ssn | |||||
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 Required Pattern: true | ||||
type | SΣ | 1..* | CodeableConcept | Kind of organization Binding: Organization Type Value Set (extensible) | ||||
name | SΣC | 1..1 | string | Name used for the organization | ||||
alias | S | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
org-alias-type | S | 0..1 | CodeableConcept | NDH Organization Alias Type URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-type Binding: Organization Alias Type Value Sete (example) | ||||
org-alias-period | S | 0..1 | Period | NDH Organization Alias Period URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-period | ||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
telecom | SC | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' | ||||
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 | S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | ||||
via-intermediary | S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary | ||||
language-speak | 0..* | code | Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible) | |||||
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 | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | SΣ | 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..* | Address | An address for the organization org-2: An address of an organization can never be of use 'home' | ||||
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 | |||||
geolocation | S | 0..1 | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation | ||||
use | ?!SΣ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
type | SΣ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
text | SΣ | 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Σ | 0..1 | Reference(National Directory API Organization Profile) | The organization of which this organization forms a part | ||||
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 | S | 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 | ||||
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 | ?!SΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
text | SΣ | 0..1 | string | Text representation of the full name | ||||
family | SΣ | 0..1 | string | Family name (often called 'Surname') | ||||
given | SΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | SΣ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | SΣ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
period | SΣ | 0..1 | Period | Time period when name was/is in use | ||||
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 | S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | ||||
via-intermediary | S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH 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 | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
address | S | 0..1 | Address | Visiting or postal addresses for the contact | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!SΣ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
type | SΣ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
text | SΣ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
city | 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) | ||||
postalCode | SΣ | 0..1 | string | Postal code for area 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"} | ||||
endpoint | S | 0..* | Reference(National Directory API Endpoint Profile) | Technical endpoints providing access to services operated for the organization | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Organization.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Organization.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Organization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Organization.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Organization.type | extensible | OrgTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/OrgTypeVS from this IG | ||||
Organization.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Organization.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Organization.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Organization.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | ||||
Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/ )http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state | ||||
Organization.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-type from the FHIR Standard | ||||
Organization.contact.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Organization.contact.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Organization.contact.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Organization.contact.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Organization.contact.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
us-core-16 | error | Organization.identifier:NPI | NPI must be 10 digits : value.matches('^[0-9]{10}$') | |
us-core-17 | error | Organization.identifier:NPI | NPI check digit must be valid (Luhn algorithm check) : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0) | |
us-core-18 | error | Organization.identifier:CLIA | CLIA number must be 10 digits with a letter "D" in third position : value.matches('^[0-9]{2}D[0-9]{7}$') | |
us-core-19 | error | Organization.identifier:NAIC | NAIC must be 5 digits : value.matches('^[0-9]{5}$') |
This structure is derived from NdhOrganization
Summary
Mandatory: 2 elements(3 nested mandatory elements)
Must-Support: 47 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from NdhOrganization
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | NdhOrganization | |||
meta | S | 0..1 | Meta | Metadata about the resource |
profile | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
extension | 1..* | Extension | Extension | |
Slices for extension | Content/Rules for all slices | |||
extension:org-description | S | 0..1 | OrgDescription | NDH Org Description |
extension:digitalcertificate | S | 0..* | Digitalcertificate | NDH Digitalcertificate |
extension:qualification | S | 0..* | Qualification | NDH Qualification |
extension:insuranceplan | S | 0..* | InsurancePlanReference | NDH InsurancePlan Reference |
value[x] | 1..1 | Reference(National Directory API InsurancePlan Profile) | Value of extension | |
extension:verification-status | S | 1..1 | VerificationStatus | NDH Verification Status |
identifier | 0..* | Identifier | Identifies this organization across multiple systems | |
extension | 1..* | Extension | Extension | |
Slices for extension | Content/Rules for all slices | |||
extension:identifier-status | S | 1..1 | IdentifierStatus | NDH Identifier Status |
use | S | 0..1 | code | usual | official | temp | secondary | old (If known) |
type | S | 0..1 | CodeableConcept | Description of identifier |
assigner | S | 0..1 | Reference(National Directory API Organization Profile) | Organization that issued id (may be just text) |
alias | ||||
Slices for extension | Content/Rules for all slices | |||
extension:org-alias-type | S | 0..1 | OrgAliasType | NDH Organization Alias Type |
extension:org-alias-period | S | 0..1 | OrgAliasPeriod | NDH Organization Alias Period |
telecom | ||||
Slices for extension | Content/Rules for all slices | |||
extension:contactpoint-availabletime | S | 0..* | ContactPointAvailableTime | NDH Contactpoint Availabletime |
extension:via-intermediary | S | 0..1 | ViaIntermediary | NDH Via Intermediary |
use | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
rank | S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
address | ||||
Slices for extension | Content/Rules for all slices | |||
extension:geolocation | S | 0..1 | Geolocation(4.0.1) | The absolute geographic location |
use | S | 0..1 | code | home | work | temp | old | billing - purpose of this address |
type | S | 0..1 | code | postal | physical | both |
text | S | 0..1 | string | Text representation of the address |
partOf | S | 0..1 | Reference(National Directory API Organization Profile) | The organization of which this organization forms a part |
contact | S | 0..* | BackboneElement | Contact for the organization for a certain purpose |
purpose | S | 0..1 | CodeableConcept | The type of contact |
name | S | 0..1 | HumanName | A name associated with the contact |
use | S | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden |
text | S | 0..1 | string | Text representation of the full name |
family | S | 0..1 | string | Family name (often called 'Surname') |
given | S | 0..* | string | Given names (not always 'first'). Includes middle names |
prefix | S | 0..* | string | Parts that come before the name |
suffix | S | 0..* | string | Parts that come after the name |
period | S | 0..1 | Period | Time period when name was/is in use |
telecom | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
Slices for extension | Content/Rules for all slices | |||
extension:contactpoint-availabletime | S | 0..* | ContactPointAvailableTime | NDH Contactpoint Availabletime |
extension:via-intermediary | S | 0..1 | ViaIntermediary | NDH Via Intermediary |
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other |
value | S | 0..1 | string | The actual contact point details |
use | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
rank | S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
address | S | 0..1 | Address | Visiting or postal addresses for the contact |
use | S | 0..1 | code | home | work | temp | old | billing - purpose of this address |
type | S | 0..1 | code | postal | physical | both |
text | S | 0..1 | string | Text representation of the address |
line | S | 0..* | string | Street name, number, direction & P.O. Box etc. |
city | S | 0..1 | string | Name of city, town etc. |
state | S | 0..1 | string | Sub-unit of country (abbreviations ok) |
postalCode | S | 0..1 | string | Postal code for area |
country | S | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
endpoint | 0..* | Reference(National Directory API 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..* | NdhOrganization | A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one |
meta | SΣ | 0..1 | Meta | Metadata about the resource |
lastUpdated | Σ | 1..1 | instant | When the resource version last changed |
profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
rating | 0..* | (Complex) | NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating | |
paymentaccepted | 0..* | CodeableConcept | NDH Payment Accepted URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: hl7VS-paymentMethodCode (required) | |
fundingSource | 0..* | (Complex) | NDH Funding Source URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource | |
org-description | S | 0..1 | string | NDH Org Description URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-description |
digitalcertificate | S | 0..* | (Complex) | NDH Digitalcertificate URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate |
qualification | S | 0..* | (Complex) | NDH Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification |
usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |
insuranceplan | S | 0..* | (Complex) | NDH InsurancePlan Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-insuranceplan-reference |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-insuranceplan-reference" | |
value[x] | S | 1..1 | Reference(National Directory API InsurancePlan Profile) | Value of extension |
verification-status | S | 1..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) |
logo | 0..1 | Attachment | NDH Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this |
identifier:All Slices | Content/Rules for all slices | |||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
identifier-status | S | 1..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) |
use | ?!SΣ | 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(National Directory API Organization Profile) | Organization that issued id (may be just text) |
identifier:NPI | SΣC | 0..* | Identifier | National Provider Identifier (NPI) us-core-16: NPI must be 10 digits us-core-17: NPI check digit must be valid (Luhn algorithm check) 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..* | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories us-core-18: CLIA number must be 10 digits with a letter "D" in third position 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 | |
identifier:NAIC | ΣC | 0..* | Identifier | NAIC Code us-core-19: NAIC must be 5 digits 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.6.300 | |
identifier:TID | SΣC | 0..1 | Identifier | Tax Identifier Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org.fhir/sid/us-ssn | |
active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use Required Pattern: true |
type | SΣ | 1..* | CodeableConcept | Kind of organization Binding: Organization Type Value Set (extensible) |
name | SΣC | 1..1 | string | Name used for the organization |
alias | S | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past |
Slices for extension | Content/Rules for all slices | |||
org-alias-type | S | 0..1 | CodeableConcept | NDH Organization Alias Type URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-type Binding: Organization Alias Type Value Sete (example) |
org-alias-period | S | 0..1 | Period | NDH Organization Alias Period URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-period |
telecom | SC | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' |
Slices for extension | Content/Rules for all slices | |||
contactpoint-availabletime | S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime |
via-intermediary | S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary |
language-speak | 0..* | code | Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible) | |
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 | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
rank | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
address | SC | 0..* | Address | An address for the organization org-2: An address of an organization can never be of use 'home' |
Slices for extension | Content/Rules for all slices | |||
geolocation | S | 0..1 | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation |
use | ?!SΣ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
type | SΣ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
text | SΣ | 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 |
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Σ | 0..1 | Reference(National Directory API Organization Profile) | The organization of which this organization forms a part |
contact | S | 0..* | BackboneElement | Contact for the organization for a certain purpose |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
purpose | S | 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 |
use | ?!SΣ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
text | SΣ | 0..1 | string | Text representation of the full name |
family | SΣ | 0..1 | string | Family name (often called 'Surname') |
given | SΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
prefix | SΣ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
suffix | SΣ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
period | SΣ | 0..1 | Period | Time period when name was/is in use |
telecom | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
Slices for extension | Content/Rules for all slices | |||
contactpoint-availabletime | S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime |
via-intermediary | S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH 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 | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
rank | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
address | S | 0..1 | Address | Visiting or postal addresses for the contact |
use | ?!SΣ | 0..1 |