Colorado BHA FHIR Implementation Guide
0.1.0-current - ci-build Unknown region code '840'

Colorado BHA FHIR Implementation Guide, published by Colorado Behavioral Health Administration. This guide is not an authorized publication; it is the continuous build for version 0.1.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/RatioPBC/bha-ig/ and changes regularly. See the Directory of published versions

## Resource Profile: Colorado BHA Provider Organization Profile

Official URL: http://bha.colorado.gov/fhir/bha-ig/StructureDefinition/bha-organization | Version: 0.1.0-current
Standards status: Trial-use | Maturity Level: 0 | Computable Name: BHAOrganization

Provider Organization profile for Colorado BHASO clinics

Usages:

- Refer to this Profile: Colorado BHA Episode Profile
- Examples for this Profile: Community Health Clinic

You can also check for usages in the FHIR IG Statistics

### 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..* | USCoreOrganizationProfile(6.1.0) | 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 | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this
identifier:NPI | S Σ C | 1..1 | 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
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 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
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 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
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)
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
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: UspsTwoLetterAlphabeticCodes (6.1.0) (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)
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Organization.telecom.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Organization.telecom.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Organization.address.​use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Organization.address.​state | Base | extensible | USPS Two Letter Alphabetic Codes | 📍6.1.0 | US Core v6.1

#### 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 USCoreOrganizationProfile

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization |  | 0..* | USCoreOrganizationProfile(6.1.0) | A grouping of people or organizations with a common purpose
identifier |  | 1..* | Identifier | Identifies this organization across multiple systems
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:NPI |  | 1..1 | Identifier | National Provider Identifier (NPI)
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C | 0..* | USCoreOrganizationProfile(6.1.0) | 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 | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this
identifier:NPI | S Σ C | 1..1 | 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
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 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
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 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
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)
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
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: UspsTwoLetterAlphabeticCodes (6.1.0) (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 | Σ | 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.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 | 📍6.1.0 | US Core v6.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 USCoreOrganizationProfile

Summary

Mandatory: 2 elements

Maturity: 0

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C | 0..* | USCoreOrganizationProfile(6.1.0) | 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 | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this
identifier:NPI | S Σ C | 1..1 | 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
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 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
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 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
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)
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
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: UspsTwoLetterAlphabeticCodes (6.1.0) (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)
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Organization.telecom.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Organization.telecom.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Organization.address.​use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Organization.address.​state | Base | extensible | USPS Two Letter Alphabetic Codes | 📍6.1.0 | US Core v6.1

#### 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 USCoreOrganizationProfile

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization |  | 0..* | USCoreOrganizationProfile(6.1.0) | A grouping of people or organizations with a common purpose
identifier |  | 1..* | Identifier | Identifies this organization across multiple systems
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:NPI |  | 1..1 | Identifier | National Provider Identifier (NPI)
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C | 0..* | USCoreOrganizationProfile(6.1.0) | 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 | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this
identifier:NPI | S Σ C | 1..1 | 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
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 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
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 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
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)
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
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: UspsTwoLetterAlphabeticCodes (6.1.0) (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 | Σ | 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.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 | 📍6.1.0 | US Core v6.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 USCoreOrganizationProfile

Summary

Mandatory: 2 elements

Maturity: 0

Other representations of profile: CSV, Excel, Schematron