US Core Implementation Guide
9.0.0 - STU 9 US

US Core Implementation Guide - Downloaded Version 9.0.0 See the Directory of published versions

## Resource Profile: US Core Organization Profile

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | Version: 9.0.0
Standards status: Trial-use | Maturity Level: 5 | Computable Name: USCoreOrganizationProfile
Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.49

The US Core Organization Profile inherits from the FHIR Organization resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Organization resource to record, search, and fetch patient or provider organization information. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

Example Usage Scenarios:

The following are example usage scenarios for this profile:

- Query by organization name or NPI

### Mandatory and Must Support Data Elements

The following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.

Each Organization Must Have:

1. A status of the organization (i.e., whether it is still active )
2. A name

Each Organization Must Support:

1. An identifier1
2. A list of contact information
3. An address2

1,2 see guidance below

### Profile Specific Implementation Guidance

This section provides detailed implementation guidance for the US Core Profile to support implementation and certification.

- 1Systems SHALL support National Provider Identifier (NPI) for organizations§ and SHOULD support Clinical Laboratory Improvement Amendments (CLIA) for laboratories and the National Association of Insurance Commissioners NAIC Company code (sometimes called "NAIC Number" or "cocode") for payers.§,§
- 2 For `Organization.address.state`, this profile uses USPS Two Letter Alphabetic Codes for US states. When encoding addresses outside the US, systems SHOULD use the ISO 3166 subdivision codes.§

Usages:

- Refer to this Profile: US Core ADI DocumentReference Profile, US Core Average Blood Pressure Profile, US Core Care Experience Preference Profile, US Core CarePlan Profile... Show 25 more, US Core CareTeam Profile, US Core Coverage Profile, US Core DiagnosticReport Profile for Laboratory Results Reporting, US Core DiagnosticReport Profile for Report and Note Exchange, US Core DocumentReference Profile, US Core Encounter Profile, US Core Immunization Profile, US Core Location Profile, US Core MedicationDispense Profile, US Core MedicationRequest Profile, US Core Observation ADI Documentation Profile, US Core Observation Clinical Result Profile, US Core Observation Occupation Profile, US Core Observation Pregnancy Intent Profile, US Core Observation Pregnancy Status Profile, US Core Observation Screening Assessment Profile, US Core PractitionerRole Profile, US Core Procedure Profile, US Core Provenance Profile, US Core QuestionnaireResponse Profile, US Core ServiceRequest Profile, US Core Simple Observation Profile, US Core Smoking Status Observation Profile, US Core Treatment Intervention Preference Profile and US Core Vital Signs Profile
- Examples for this Profile: Acme Labs, Acme Health Plan, Acme Clinic, Holy Healthcare and Saint Luke's Hospital of Kansas City
- CapabilityStatements using this Profile: US Core Client CapabilityStatement and US Core Server CapabilityStatement

You can also check for usages in the FHIR IG Statistics

Changes since version 8.0.1:

- The resource metadata has changed (description, copyright)

### Formal Views of Profile Content

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

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C | 0..* | Organization | A grouping of people or organizations with a common purpose Constraints: org-1
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
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 value:$this
identifier:All Slices |  |  |  | Content/Rules for all slices
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
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
identifier:NPI | S Σ C | 0..* | Identifier | National Provider Identifier (NPI) Constraints: us-core-16, us-core-17 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
type |  | 0..1 | CodeableConcept | Description of identifier
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)
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
value | S Σ | 0..1 | string | The value that is unique Example General: 123456
identifier:CLIA | Σ C | 0..* | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Constraints: us-core-18 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
type |  | 0..1 | CodeableConcept | Description of identifier
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)
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7
value | S Σ | 0..1 | string | The value that is unique Example General: 123456
identifier:NAIC | Σ C | 0..* | Identifier | NAIC Code Constraints: us-core-19 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
type |  | 0..1 | CodeableConcept | Description of identifier
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)
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.300
value | S Σ | 0..1 | string | The value that is unique Example General: 123456
active | ?!S Σ | 1..1 | boolean | Whether the organization's record is still in active use
name | S Σ C | 1..1 | string | Name used for the organization
telecom | S C | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
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 | S C | 0..* | Address | An address for the organization Constraints: org-2
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 Example US Core: 49 MEADOW ST
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. Example US Core: OK
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132 Example US Core: 74047
country | S Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Organization.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Organization.identifier:NPI.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Organization.identifier:CLIA.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Organization.identifier:NAIC.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Organization.telecom.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Organization.telecom.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Organization.address.​use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Organization.address.​state | Base | extensible | USPS Two Letter Alphabetic Codes | 📦1.0.0 | THO v7.1

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Organization | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one | `(identifier.count() + name.count()) > 0`
org-2 | error | Organization.address | An address of an organization can never be of use 'home' | `where(use = 'home').empty()`
org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' | `where(use = 'home').empty()`
us-core-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 Organization

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization |  | 0..* | Organization | A grouping of people or organizations with a common purpose
Slices for identifier | S | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:$this
identifier:All Slices |  |  |  | Content/Rules for all slices
system | S | 0..1 | uri | The namespace for the identifier value
value | S | 0..1 | string | The value that is unique
identifier:NPI | S C | 0..* | Identifier | National Provider Identifier (NPI) Constraints: us-core-16, us-core-17 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 Constraints: us-core-18 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 Constraints: us-core-19 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
active | S | 1..1 | boolean | Whether the organization's record is still in active use
name | S | 1..1 | string | Name used for the organization
telecom | S | 0..* | ContactPoint | A contact detail for the organization
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other
value | S | 0..1 | string | The actual contact point details
address | S | 0..* | Address | An address for the organization
line | S | 0..4 | string | Street name, number, direction & P.O. Box etc. Example US Core: 49 MEADOW ST
city | S | 0..1 | string | Name of city, town etc. Example US Core: EVERYTOWN
state | S | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. Example US Core: OK
postalCode | S | 0..1 | string | US Zip Codes Example US Core: 74047
country | S | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Organization.address.​state | Base | extensible | USPS Two Letter Alphabetic Codes | 📦1.0.0 | THO v7.1

#### Constraints

Id | Grade | Path(s) | Description | Expression
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 Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C | 0..* | Organization | A grouping of people or organizations with a common purpose Constraints: org-1
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
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 value:$this
identifier:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 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 | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:NPI | S Σ C | 0..* | Identifier | National Provider Identifier (NPI) Constraints: us-core-16, us-core-17 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 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 Fixed Value: http://hl7.org/fhir/sid/us-npi
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 | Σ | 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 Constraints: us-core-18 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 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 Fixed Value: urn:oid:2.16.840.1.113883.4.7
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 | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:NAIC | Σ C | 0..* | Identifier | NAIC Code Constraints: us-core-19 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 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 Fixed Value: urn:oid:2.16.840.1.113883.6.300
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 | Σ | 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
type | Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example): Used to categorize the organization.
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 | S C | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
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 | S C | 0..* | Address | An address for the organization Constraints: org-2
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 Example US Core: 49 MEADOW ST
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN
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. Example US Core: OK
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132 Example US Core: 74047
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 | Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part
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 |  | 0..1 | HumanName | A name associated with the contact
telecom |  | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact
address |  | 0..1 | Address | Visiting or postal addresses for the contact
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Organization.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
Organization.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Organization.identifier.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
Organization.identifier:NPI.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Organization.identifier:NPI.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
Organization.identifier:CLIA.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Organization.identifier:CLIA.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
Organization.identifier:NAIC.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Organization.identifier:NAIC.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
Organization.type | Base | example | Organization type | 📍4.0.1 | FHIR Std.
Organization.telecom.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Organization.telecom.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Organization.address.​use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Organization.address.​type | Base | required | AddressType | 📍4.0.1 | FHIR Std.
Organization.address.​state | Base | extensible | USPS Two Letter Alphabetic Codes | 📦1.0.0 | THO v7.1
Organization.contact.​purpose | Base | extensible | Contact entity type | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Organization | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one | `(identifier.count() + name.count()) > 0`
org-2 | error | Organization.address | An address of an organization can never be of use 'home' | `where(use = 'home').empty()`
org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' | `where(use = 'home').empty()`
us-core-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 Organization

Summary

Mandatory: 2 elements
Must-Support: 15 elements

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Organization.identifier

Maturity: 5

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C | 0..* | Organization | A grouping of people or organizations with a common purpose Constraints: org-1
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
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 value:$this
identifier:All Slices |  |  |  | Content/Rules for all slices
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
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
identifier:NPI | S Σ C | 0..* | Identifier | National Provider Identifier (NPI) Constraints: us-core-16, us-core-17 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
type |  | 0..1 | CodeableConcept | Description of identifier
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)
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
value | S Σ | 0..1 | string | The value that is unique Example General: 123456
identifier:CLIA | Σ C | 0..* | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Constraints: us-core-18 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
type |  | 0..1 | CodeableConcept | Description of identifier
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)
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7
value | S Σ | 0..1 | string | The value that is unique Example General: 123456
identifier:NAIC | Σ C | 0..* | Identifier | NAIC Code Constraints: us-core-19 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
type |  | 0..1 | CodeableConcept | Description of identifier
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)
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.300
value | S Σ | 0..1 | string | The value that is unique Example General: 123456
active | ?!S Σ | 1..1 | boolean | Whether the organization's record is still in active use
name | S Σ C | 1..1 | string | Name used for the organization
telecom | S C | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
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 | S C | 0..* | Address | An address for the organization Constraints: org-2
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 Example US Core: 49 MEADOW ST
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. Example US Core: OK
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132 Example US Core: 74047
country | S Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Organization.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Organization.identifier:NPI.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Organization.identifier:CLIA.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Organization.identifier:NAIC.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Organization.telecom.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Organization.telecom.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Organization.address.​use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Organization.address.​state | Base | extensible | USPS Two Letter Alphabetic Codes | 📦1.0.0 | THO v7.1

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Organization | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one | `(identifier.count() + name.count()) > 0`
org-2 | error | Organization.address | An address of an organization can never be of use 'home' | `where(use = 'home').empty()`
org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' | `where(use = 'home').empty()`
us-core-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}$')`

Differential View

This structure is derived from Organization

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization |  | 0..* | Organization | A grouping of people or organizations with a common purpose
Slices for identifier | S | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:$this
identifier:All Slices |  |  |  | Content/Rules for all slices
system | S | 0..1 | uri | The namespace for the identifier value
value | S | 0..1 | string | The value that is unique
identifier:NPI | S C | 0..* | Identifier | National Provider Identifier (NPI) Constraints: us-core-16, us-core-17 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 Constraints: us-core-18 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 Constraints: us-core-19 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
active | S | 1..1 | boolean | Whether the organization's record is still in active use
name | S | 1..1 | string | Name used for the organization
telecom | S | 0..* | ContactPoint | A contact detail for the organization
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other
value | S | 0..1 | string | The actual contact point details
address | S | 0..* | Address | An address for the organization
line | S | 0..4 | string | Street name, number, direction & P.O. Box etc. Example US Core: 49 MEADOW ST
city | S | 0..1 | string | Name of city, town etc. Example US Core: EVERYTOWN
state | S | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. Example US Core: OK
postalCode | S | 0..1 | string | US Zip Codes Example US Core: 74047
country | S | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Organization.address.​state | Base | extensible | USPS Two Letter Alphabetic Codes | 📦1.0.0 | THO v7.1

#### Constraints

Id | Grade | Path(s) | Description | Expression
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}$')`

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C | 0..* | Organization | A grouping of people or organizations with a common purpose Constraints: org-1
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
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 value:$this
identifier:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 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 | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:NPI | S Σ C | 0..* | Identifier | National Provider Identifier (NPI) Constraints: us-core-16, us-core-17 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 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 Fixed Value: http://hl7.org/fhir/sid/us-npi
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 | Σ | 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 Constraints: us-core-18 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 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 Fixed Value: urn:oid:2.16.840.1.113883.4.7
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 | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:NAIC | Σ C | 0..* | Identifier | NAIC Code Constraints: us-core-19 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 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 Fixed Value: urn:oid:2.16.840.1.113883.6.300
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 | Σ | 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
type | Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example): Used to categorize the organization.
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 | S C | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
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 | S C | 0..* | Address | An address for the organization Constraints: org-2
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 Example US Core: 49 MEADOW ST
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN
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. Example US Core: OK
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132 Example US Core: 74047
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 | Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part
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 |  | 0..1 | HumanName | A name associated with the contact
telecom |  | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact
address |  | 0..1 | Address | Visiting or postal addresses for the contact
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Organization.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
Organization.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Organization.identifier.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
Organization.identifier:NPI.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Organization.identifier:NPI.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
Organization.identifier:CLIA.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Organization.identifier:CLIA.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
Organization.identifier:NAIC.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Organization.identifier:NAIC.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
Organization.type | Base | example | Organization type | 📍4.0.1 | FHIR Std.
Organization.telecom.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Organization.telecom.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Organization.address.​use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Organization.address.​type | Base | required | AddressType | 📍4.0.1 | FHIR Std.
Organization.address.​state | Base | extensible | USPS Two Letter Alphabetic Codes | 📦1.0.0 | THO v7.1
Organization.contact.​purpose | Base | extensible | Contact entity type | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Organization | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one | `(identifier.count() + name.count()) > 0`
org-2 | error | Organization.address | An address of an organization can never be of use 'home' | `where(use = 'home').empty()`
org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' | `where(use = 'home').empty()`
us-core-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 Organization

Summary

Mandatory: 2 elements
Must-Support: 15 elements

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Organization.identifier

Maturity: 5

Other representations of profile: CSV, Excel, Schematron

### Notes:

Quick Start

Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

- See the Scopes Format section for a description of the SMART scopes syntax.
- See the Search Syntax section for a description of the US Core search syntax.
- See the General Requirements section for additional rules and expectations when a Server requires status parameters.
- See the General Guidance section for additional guidance on searching for multiple patients.

#### US Core Scopes

Servers providing access to organization data SHALL support these US Core SMART Scopes:

- resource level scopes: `<patient|user|system>/Organization.rs` §

#### Mandatory Search Parameters:

The following search parameters and search parameter combinations SHALL be supported:

1. SHALL support searching organization based on text address using the address search parameter

   `GET [base]/Organization?address=[address]`

   Example:

   > 1. GET [base]/Organization?address=Ann%20Arbor

   Implementation Notes: Fetches a bundle of all US Core Organization Profile resources that match the address string ( see how to search by string).

2. SHALL support searching by organization name using the name search parameter

   `GET [base]/Organization?name=[name]`

   Example:

   > 1. GET [base]/Organization?name=ACME%20Labs

   Implementation Notes: Fetches a bundle of all US Core Organization Profile resources that match the name ( see how to search by string).