Carequality Healthcare Directory ImplementationGuide
1.13.0 - Release 1

Carequality Healthcare Directory ImplementationGuide - Local Development build (v1.13.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: Carequality Organization ( Abstract )

Official URL: https://sequoiaproject.org/fhir/cq/StructureDefinition/CarequalityOrganization | Version: 1.13.0
Active as of 2026-04-07 | Computable Name: CarequalityOrganization

This profile on the FHIR Organization resource is an abstract base profile that defines shared constraints for all other profiles on the Organization resource in this implementation guide. It is not intended to be used directly, rather end users should create instances conforming to the Carequality Connection or Carequality Implementer profiles.

Usages:

- Derived from this Profile: Carequality Connection and Carequality Implementer
- Refer to this Profile: Carequality Endpoint and Carequality Organization

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..* | SequoiaOrganization | This is an abstract profile. Child profiles: CarequalityConnection, CarequalityImplementer A grouping of people or organizations with a common purpose Constraints: org-1, so-1, so-2, cq-o1
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:domains | S | 1..* | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains Binding: Domains (required)
extension:hubservicesubscriptions |  | 0..* | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions Binding: Hub Service Subscriptions (required)
extension:administrativestatus |  | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus Binding: Administrative Status (required)
extension:hubroutingstatus |  | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus Binding: Hub Routing Status (required)
extension:initiatoronly | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly Binding: Initiator Only (required)
extension:org-managing-org | S | 0..1 | Reference(Sequoia Organization) | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org
extension:purposesofuse | S | 0..* | (Complex) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Purpose Of Use (required)
extension:stateofoperation | S | 0..* | Address | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation
extension:usecases | S | 0..* | CodeableConcept | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases Binding: Endpoint Use Case Codes (required)
extension:doa | S | 0..* | Reference(Sequoia Organization) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/DOA
extension:transaction | S | 0..* | CodeableConcept | When used on an organization, this represents initiating transactions URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction Binding: Transactions (required)
extension:delegation-role | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/DelegationRole Binding: Delegation Role Value Set (required)
extension:organization-node-type |  | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrganizationNodeType Binding: Organization Node Type ValueSet (required)
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 | 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
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)
identifier:CCN | S Σ C | 0..1 | Identifier | CMS Certification Number (CCN) 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.336
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:HCID | S Σ C | 1..1 | Identifier | OID (such as a Home Community ID) or UUID 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 |  | 1..1 | CodeableConcept | Description of identifier Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HCID
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986
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:AAID | S Σ C | 0..* | Identifier | OID (such as an Assiging Authority ID) or UUID 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 |  | 1..1 | CodeableConcept | Description of identifier Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AAID
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986
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:TEFCAID | S Σ C | 0..* | Identifier | TEFCA Identifier Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 1..1 | CodeableConcept | Description of identifier Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: TEFCAID
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986
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
Slices for type | S Σ | 1..* | CodeableConcept | Kind of organization Slice: Unordered, Open by pattern:$this Binding: OrganizationType (example): Used to categorize the organization.
type:sequoiaorgtype | S Σ | 1..1 | CodeableConcept | Kind of organization Binding: Organization Type (required)
type:hl7orgrole | S Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationAffiliationRole (required)
name | S Σ C | 1..1 | string | Name used for the organization
alias | S | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past
Slices for telecom | S C | 0..* | ContactPoint | A contact detail for the organization Slice: Unordered, Open by value:system Constraints: org-3
telecom:phone | S C | 0..1 | ContactPoint | A contact detail for the organization Constraints: org-3
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone
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.
telecom:email | S C | 0..1 | ContactPoint | A contact detail for the organization Constraints: org-3
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email
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.
Slices for address | S C | 1..* | Address | An address for the organization Slice: Unordered, Open by value:country Constraints: org-2
address:All Slices |  |  |  | Content/Rules for all slices
extension | S | 1..* | Reference(Sequoia Location) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation 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
text | S Σ | 1..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | S Σ | 0..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
country | S Σ | 1..1 | string | Must be an ISO 3166 2 or 3 letter code, with 2 letter codes preferred for compliance with later versions of US Core Organization
address:united-states-address | S C | 0..* | Address | An address for the organization Constraints: org-2
extension | S | 1..* | Reference(Sequoia Location) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation 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
text | S Σ | 1..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | S Σ | 0..1 | 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 Σ | 1..1 | string | Name of city, town etc. Example General: Erewhon
state | S Σ | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (required): Two letter USPS alphabetic codes.
postalCode | S Σ | 1..1 | string | US Zip Codes Example General: 9132
country | S Σ | 1..1 | string | Must be an ISO 3166 2 or 3 letter code, with 2 letter codes preferred for compliance with later versions of US Core Organization Fixed Value: US
partOf | S Σ | 0..1 | Reference(Carequality Organization) | The organization of which this organization forms a part
contact | S | 0..* | BackboneElement | Contact for the organization for a certain purpose
Slices for extension |  |  |  | Content/Rules for all slices
extension:company | S | 0..* | string | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
purpose | S | 1..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
name | S | 1..1 | HumanName | A name associated with the contact
Slices for telecom | S | 2..* | ContactPoint | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:system
telecom:phone | S | 1..* | ContactPoint | Contact details (telephone, email, etc.) for a contact
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
telecom:email | S | 1..1 | ContactPoint | Contact details (telephone, email, etc.) for a contact
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
address | S | 0..1 | Address | Visiting or postal addresses for the contact
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..1 | 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
endpoint | S | 0..* | Reference(Carequality Endpoint) | Technical endpoints providing access to services operated for the organization
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Organization.extension:purposesofuse.​value[x] | Base | required | Purpose Of Use | 📦1.13.0 | This IG
Organization.type | Base | example | Organization type | 📦4.0.1 | FHIR Std.
Organization.type:sequoiaorgtype | Base | required | Organization Type | 📦1.13.0 | This IG
Organization.type:hl7orgrole | Base | required | Organization Affiliation Role | 📦4.0.1 | FHIR Std.
Organization.telecom:phone.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Organization.telecom:phone.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Organization.telecom:email.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Organization.telecom:email.​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
Organization.address:united-states-address.​use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Organization.address:united-states-address.​state | Base | required | 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.
Organization.contact.​telecom:phone.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Organization.contact.​telecom:phone.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Organization.contact.​telecom:email.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Organization.contact.​telecom:email.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Organization.contact.​address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
cq-o1 | error | Organization | A Carequailty Organization must have an Organization.type:sequoiaorgtype of Connection or Implementer. | `type.where(coding.where(system='https://sequoiaproject.org/fhir/sphd/CodeSystem/OrganizationType' and code='Connection').exists()).exists() or type.where(coding.where(system='https://sequoiaproject.org/fhir/sphd/CodeSystem/OrganizationType' and code='Implementer').exists()).exists()`
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, Organization.address:united-states-address | An address of an organization can never be of use 'home' | `where(use = 'home').empty()`
org-3 | error | Organization.telecom, Organization.telecom:phone, Organization.telecom:email | The telecom of an organization can never be of use 'home' | `where(use = 'home').empty()`
so-1 | error | Organization | For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier | `endpoint.exists() implies identifier.where(type.coding.first().code='HCID').single().value.substring(8)=id`
so-2 | warning | Organization | If Organization.type:hl7orgrole = 'payer' then Organization.identifier:NAIC is required | `type.where(coding.first().code='payer').exists() implies identifier.where(system='urn:oid:2.16.840.1.113883.6.300').exists()`
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 SequoiaOrganization

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C | 0..* | SequoiaOrganization | This is an abstract profile. Child profiles: CarequalityConnection, CarequalityImplementer A grouping of people or organizations with a common purpose Constraints: cq-o1
Slices for extension |  |  |  | Content/Rules for all slices
extension:purposesofuse |  | 0..* | PurposesOfUse | Extension
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Purpose Of Use (required)
extension:usecases | S | 0..* | UseCases | Optional Extensions Element
Slices for telecom |  |  |  | Content/Rules for all slices
telecom:phone |  | 0..1 | ContactPoint | A contact detail for the organization
telecom:email |  | 0..1 | ContactPoint | A contact detail for the organization
Slices for address |  | 1..* | Address | An address for the organization Slice: Unordered, Open by value:country
address:All Slices |  |  |  | Content/Rules for all slices
extension |  | 1..* | OrgLocation | Extension
text | S | 1..1 | string | Text representation of the address
country |  | 1..1 | string | Must be an ISO 3166 2 or 3 letter code, with 2 letter codes preferred for compliance with later versions of US Core Organization
address:united-states-address | S | 0..* | Address | An address for the organization
city |  | 1..1 | string | Name of city, town etc.
state |  | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (required): Two letter USPS alphabetic codes.
postalCode |  | 1..1 | string | US Zip Codes
country |  | 1..1 | string | Must be an ISO 3166 2 or 3 letter code, with 2 letter codes preferred for compliance with later versions of US Core Organization Fixed Value: US
partOf |  | 0..1 | Reference(Carequality Organization) | The organization of which this organization forms a part
contact |  |  |  |
purpose | S | 1..1 | CodeableConcept | The type of contact
name | S | 1..1 | HumanName | A name associated with the contact
telecom |  | 2..* | ContactPoint | Contact details (telephone, email, etc.) for a contact
Slices for telecom |  |  |  | Content/Rules for all slices
telecom:phone |  | 1..* | ContactPoint | Contact details (telephone, email, etc.) for a contact
telecom:email |  | 1..1 | ContactPoint | Contact details (telephone, email, etc.) for a contact
endpoint |  | 0..* | Reference(Carequality Endpoint) | Technical endpoints providing access to services operated for the organization
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Organization.extension:purposesofuse.​value[x] | Base | required | Purpose Of Use | 📦1.13.0 | This IG
Organization.address:united-states-address.​state | Base | required | USPS Two Letter Alphabetic Codes | 📦6.1.0 | US Core v6.1

#### Constraints

Id | Grade | Path(s) | Description | Expression
cq-o1 | error | Organization | A Carequailty Organization must have an Organization.type:sequoiaorgtype of Connection or Implementer. | `type.where(coding.where(system='https://sequoiaproject.org/fhir/sphd/CodeSystem/OrganizationType' and code='Connection').exists()).exists() or type.where(coding.where(system='https://sequoiaproject.org/fhir/sphd/CodeSystem/OrganizationType' and code='Implementer').exists()).exists()`

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C | 0..* | SequoiaOrganization | This is an abstract profile. Child profiles: CarequalityConnection, CarequalityImplementer A grouping of people or organizations with a common purpose Constraints: org-1, so-1, so-2, cq-o1
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
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:domains | S | 1..* | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains Binding: Domains (required)
extension:hubservicesubscriptions |  | 0..* | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions Binding: Hub Service Subscriptions (required)
extension:administrativestatus |  | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus Binding: Administrative Status (required)
extension:hubroutingstatus |  | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus Binding: Hub Routing Status (required)
extension:initiatoronly | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly Binding: Initiator Only (required)
extension:org-managing-org | S | 0..1 | Reference(Sequoia Organization) | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org
extension:purposesofuse | S | 0..* | (Complex) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Purpose Of Use (required)
extension:stateofoperation | S | 0..* | Address | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation
extension:usecases | S | 0..* | CodeableConcept | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases Binding: Endpoint Use Case Codes (required)
extension:doa | S | 0..* | Reference(Sequoia Organization) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/DOA
extension:transaction | S | 0..* | CodeableConcept | When used on an organization, this represents initiating transactions URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction Binding: Transactions (required)
extension:delegation-role | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/DelegationRole Binding: Delegation Role Value Set (required)
extension:organization-node-type |  | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrganizationNodeType Binding: Organization Node Type ValueSet (required)
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 | 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
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)
identifier:CCN | S Σ C | 0..1 | Identifier | CMS Certification Number (CCN) 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.336
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:HCID | S Σ C | 1..1 | Identifier | OID (such as a Home Community ID) or UUID 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 |  | 1..1 | CodeableConcept | Description of identifier Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HCID
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986
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:AAID | S Σ C | 0..* | Identifier | OID (such as an Assiging Authority ID) or UUID 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 |  | 1..1 | CodeableConcept | Description of identifier Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AAID
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986
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:TEFCAID | S Σ C | 0..* | Identifier | TEFCA Identifier Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 1..1 | CodeableConcept | Description of identifier Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: TEFCAID
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986
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
Slices for type | S Σ | 1..* | CodeableConcept | Kind of organization Slice: Unordered, Open by pattern:$this Binding: OrganizationType (example): Used to categorize the organization.
type:sequoiaorgtype | S Σ | 1..1 | CodeableConcept | Kind of organization Binding: Organization Type (required)
type:hl7orgrole | S Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationAffiliationRole (required)
name | S Σ C | 1..1 | string | Name used for the organization
alias | S | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past
Slices for telecom | S C | 0..* | ContactPoint | A contact detail for the organization Slice: Unordered, Open by value:system Constraints: org-3
telecom:phone | S C | 0..1 | 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 | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone
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
telecom:email | S C | 0..1 | 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 | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email
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
Slices for address | S C | 1..* | Address | An address for the organization Slice: Unordered, Open by value:country Constraints: org-2
address:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension | S | 1..* | Reference(Sequoia Location) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation 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 | S Σ | 1..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | S Σ | 0..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
country | S Σ | 1..1 | string | Must be an ISO 3166 2 or 3 letter code, with 2 letter codes preferred for compliance with later versions of US Core Organization
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
address:united-states-address | S C | 0..* | Address | An address for the organization Constraints: org-2
id |  | 0..1 | string | Unique id for inter-element referencing
extension | S | 1..* | Reference(Sequoia Location) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation 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 | S Σ | 1..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | S Σ | 0..1 | 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 Σ | 1..1 | string | Name of city, town etc. Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | S Σ | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (required): Two letter USPS alphabetic codes.
postalCode | S Σ | 1..1 | string | US Zip Codes Example General: 9132
country | S Σ | 1..1 | string | Must be an ISO 3166 2 or 3 letter code, with 2 letter codes preferred for compliance with later versions of US Core Organization Fixed Value: US
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
partOf | S Σ | 0..1 | Reference(Carequality Organization) | The organization of which this organization forms a part
contact | S | 0..* | BackboneElement | Contact for the organization for a certain purpose
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:company | S | 0..* | string | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
purpose | S | 1..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
name | S | 1..1 | HumanName | A name associated with the contact
Slices for telecom | S | 2..* | ContactPoint | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:system
telecom:phone | S | 1..* | ContactPoint | Contact details (telephone, email, etc.) for a contact
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone
value | Σ | 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
telecom:email | S | 1..1 | ContactPoint | Contact details (telephone, email, etc.) for a contact
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email
value | Σ | 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 | 0..1 | Address | Visiting or postal addresses for the contact
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 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..1 | 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 | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok)
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
endpoint | S | 0..* | Reference(Carequality 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.extension:purposesofuse.​value[x] | Base | required | Purpose Of Use | 📦1.13.0 | This IG
Organization.type | Base | example | Organization type | 📦4.0.1 | FHIR Std.
Organization.type:sequoiaorgtype | Base | required | Organization Type | 📦1.13.0 | This IG
Organization.type:hl7orgrole | Base | required | Organization Affiliation Role | 📦4.0.1 | FHIR Std.
Organization.telecom:phone.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Organization.telecom:phone.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Organization.telecom:email.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Organization.telecom:email.​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.address:united-states-address.​use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Organization.address:united-states-address.​type | Base | required | AddressType | 📍4.0.1 | FHIR Std.
Organization.address:united-states-address.​state | Base | required | 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.
Organization.contact.​telecom:phone.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Organization.contact.​telecom:phone.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Organization.contact.​telecom:email.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Organization.contact.​telecom:email.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Organization.contact.​address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Organization.contact.​address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
cq-o1 | error | Organization | A Carequailty Organization must have an Organization.type:sequoiaorgtype of Connection or Implementer. | `type.where(coding.where(system='https://sequoiaproject.org/fhir/sphd/CodeSystem/OrganizationType' and code='Connection').exists()).exists() or type.where(coding.where(system='https://sequoiaproject.org/fhir/sphd/CodeSystem/OrganizationType' and code='Implementer').exists()).exists()`
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, Organization.address:united-states-address | An address of an organization can never be of use 'home' | `where(use = 'home').empty()`
org-3 | error | Organization.telecom, Organization.telecom:phone, Organization.telecom:email | The telecom of an organization can never be of use 'home' | `where(use = 'home').empty()`
so-1 | error | Organization | For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier | `endpoint.exists() implies identifier.where(type.coding.first().code='HCID').single().value.substring(8)=id`
so-2 | warning | Organization | If Organization.type:hl7orgrole = 'payer' then Organization.identifier:NAIC is required | `type.where(coding.first().code='payer').exists() implies identifier.where(system='urn:oid:2.16.840.1.113883.6.300').exists()`
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 SequoiaOrganization

Summary

Mandatory: 2 elements(9 nested mandatory elements)
Must-Support: 5 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

- Carequality Organization (https://sequoiaproject.org/fhir/cq/StructureDefinition/CarequalityOrganization)
- Carequality Endpoint (https://sequoiaproject.org/fhir/cq/StructureDefinition/CarequalityEndpoint)

Slices

This structure defines the following Slices:

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

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C | 0..* | SequoiaOrganization | This is an abstract profile. Child profiles: CarequalityConnection, CarequalityImplementer A grouping of people or organizations with a common purpose Constraints: org-1, so-1, so-2, cq-o1
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:domains | S | 1..* | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains Binding: Domains (required)
extension:hubservicesubscriptions |  | 0..* | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions Binding: Hub Service Subscriptions (required)
extension:administrativestatus |  | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus Binding: Administrative Status (required)
extension:hubroutingstatus |  | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus Binding: Hub Routing Status (required)
extension:initiatoronly | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly Binding: Initiator Only (required)
extension:org-managing-org | S | 0..1 | Reference(Sequoia Organization) | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org
extension:purposesofuse | S | 0..* | (Complex) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Purpose Of Use (required)
extension:stateofoperation | S | 0..* | Address | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation
extension:usecases | S | 0..* | CodeableConcept | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases Binding: Endpoint Use Case Codes (required)
extension:doa | S | 0..* | Reference(Sequoia Organization) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/DOA
extension:transaction | S | 0..* | CodeableConcept | When used on an organization, this represents initiating transactions URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction Binding: Transactions (required)
extension:delegation-role | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/DelegationRole Binding: Delegation Role Value Set (required)
extension:organization-node-type |  | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrganizationNodeType Binding: Organization Node Type ValueSet (required)
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 | 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
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)
identifier:CCN | S Σ C | 0..1 | Identifier | CMS Certification Number (CCN) 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.336
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:HCID | S Σ C | 1..1 | Identifier | OID (such as a Home Community ID) or UUID 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 |  | 1..1 | CodeableConcept | Description of identifier Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HCID
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986
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:AAID | S Σ C | 0..* | Identifier | OID (such as an Assiging Authority ID) or UUID 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 |  | 1..1 | CodeableConcept | Description of identifier Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AAID
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986
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:TEFCAID | S Σ C | 0..* | Identifier | TEFCA Identifier Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 1..1 | CodeableConcept | Description of identifier Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: TEFCAID
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986
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
Slices for type | S Σ | 1..* | CodeableConcept | Kind of organization Slice: Unordered, Open by pattern:$this Binding: OrganizationType (example): Used to categorize the organization.
type:sequoiaorgtype | S Σ | 1..1 | CodeableConcept | Kind of organization Binding: Organization Type (required)
type:hl7orgrole | S Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationAffiliationRole (required)
name | S Σ C | 1..1 | string | Name used for the organization
alias | S | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past
Slices for telecom | S C | 0..* | ContactPoint | A contact detail for the organization Slice: Unordered, Open by value:system Constraints: org-3
telecom:phone | S C | 0..1 | ContactPoint | A contact detail for the organization Constraints: org-3
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone
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.
telecom:email | S C | 0..1 | ContactPoint | A contact detail for the organization Constraints: org-3
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email
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.
Slices for address | S C | 1..* | Address | An address for the organization Slice: Unordered, Open by value:country Constraints: org-2
address:All Slices |  |  |  | Content/Rules for all slices
extension | S | 1..* | Reference(Sequoia Location) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation 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
text | S Σ | 1..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | S Σ | 0..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
country | S Σ | 1..1 | string | Must be an ISO 3166 2 or 3 letter code, with 2 letter codes preferred for compliance with later versions of US Core Organization
address:united-states-address | S C | 0..* | Address | An address for the organization Constraints: org-2
extension | S | 1..* | Reference(Sequoia Location) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation 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
text | S Σ | 1..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | S Σ | 0..1 | 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 Σ | 1..1 | string | Name of city, town etc. Example General: Erewhon
state | S Σ | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (required): Two letter USPS alphabetic codes.
postalCode | S Σ | 1..1 | string | US Zip Codes Example General: 9132
country | S Σ | 1..1 | string | Must be an ISO 3166 2 or 3 letter code, with 2 letter codes preferred for compliance with later versions of US Core Organization Fixed Value: US
partOf | S Σ | 0..1 | Reference(Carequality Organization) | The organization of which this organization forms a part
contact | S | 0..* | BackboneElement | Contact for the organization for a certain purpose
Slices for extension |  |  |  | Content/Rules for all slices
extension:company | S | 0..* | string | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
purpose | S | 1..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
name | S | 1..1 | HumanName | A name associated with the contact
Slices for telecom | S | 2..* | ContactPoint | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:system
telecom:phone | S | 1..* | ContactPoint | Contact details (telephone, email, etc.) for a contact
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
telecom:email | S | 1..1 | ContactPoint | Contact details (telephone, email, etc.) for a contact
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
address | S | 0..1 | Address | Visiting or postal addresses for the contact
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..1 | 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
endpoint | S | 0..* | Reference(Carequality Endpoint) | Technical endpoints providing access to services operated for the organization
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Organization.extension:purposesofuse.​value[x] | Base | required | Purpose Of Use | 📦1.13.0 | This IG
Organization.type | Base | example | Organization type | 📦4.0.1 | FHIR Std.
Organization.type:sequoiaorgtype | Base | required | Organization Type | 📦1.13.0 | This IG
Organization.type:hl7orgrole | Base | required | Organization Affiliation Role | 📦4.0.1 | FHIR Std.
Organization.telecom:phone.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Organization.telecom:phone.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Organization.telecom:email.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Organization.telecom:email.​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
Organization.address:united-states-address.​use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Organization.address:united-states-address.​state | Base | required | 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.
Organization.contact.​telecom:phone.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Organization.contact.​telecom:phone.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Organization.contact.​telecom:email.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Organization.contact.​telecom:email.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Organization.contact.​address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
cq-o1 | error | Organization | A Carequailty Organization must have an Organization.type:sequoiaorgtype of Connection or Implementer. | `type.where(coding.where(system='https://sequoiaproject.org/fhir/sphd/CodeSystem/OrganizationType' and code='Connection').exists()).exists() or type.where(coding.where(system='https://sequoiaproject.org/fhir/sphd/CodeSystem/OrganizationType' and code='Implementer').exists()).exists()`
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, Organization.address:united-states-address | An address of an organization can never be of use 'home' | `where(use = 'home').empty()`
org-3 | error | Organization.telecom, Organization.telecom:phone, Organization.telecom:email | The telecom of an organization can never be of use 'home' | `where(use = 'home').empty()`
so-1 | error | Organization | For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier | `endpoint.exists() implies identifier.where(type.coding.first().code='HCID').single().value.substring(8)=id`
so-2 | warning | Organization | If Organization.type:hl7orgrole = 'payer' then Organization.identifier:NAIC is required | `type.where(coding.first().code='payer').exists() implies identifier.where(system='urn:oid:2.16.840.1.113883.6.300').exists()`
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 SequoiaOrganization

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C | 0..* | SequoiaOrganization | This is an abstract profile. Child profiles: CarequalityConnection, CarequalityImplementer A grouping of people or organizations with a common purpose Constraints: cq-o1
Slices for extension |  |  |  | Content/Rules for all slices
extension:purposesofuse |  | 0..* | PurposesOfUse | Extension
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Purpose Of Use (required)
extension:usecases | S | 0..* | UseCases | Optional Extensions Element
Slices for telecom |  |  |  | Content/Rules for all slices
telecom:phone |  | 0..1 | ContactPoint | A contact detail for the organization
telecom:email |  | 0..1 | ContactPoint | A contact detail for the organization
Slices for address |  | 1..* | Address | An address for the organization Slice: Unordered, Open by value:country
address:All Slices |  |  |  | Content/Rules for all slices
extension |  | 1..* | OrgLocation | Extension
text | S | 1..1 | string | Text representation of the address
country |  | 1..1 | string | Must be an ISO 3166 2 or 3 letter code, with 2 letter codes preferred for compliance with later versions of US Core Organization
address:united-states-address | S | 0..* | Address | An address for the organization
city |  | 1..1 | string | Name of city, town etc.
state |  | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (required): Two letter USPS alphabetic codes.
postalCode |  | 1..1 | string | US Zip Codes
country |  | 1..1 | string | Must be an ISO 3166 2 or 3 letter code, with 2 letter codes preferred for compliance with later versions of US Core Organization Fixed Value: US
partOf |  | 0..1 | Reference(Carequality Organization) | The organization of which this organization forms a part
contact |  |  |  |
purpose | S | 1..1 | CodeableConcept | The type of contact
name | S | 1..1 | HumanName | A name associated with the contact
telecom |  | 2..* | ContactPoint | Contact details (telephone, email, etc.) for a contact
Slices for telecom |  |  |  | Content/Rules for all slices
telecom:phone |  | 1..* | ContactPoint | Contact details (telephone, email, etc.) for a contact
telecom:email |  | 1..1 | ContactPoint | Contact details (telephone, email, etc.) for a contact
endpoint |  | 0..* | Reference(Carequality Endpoint) | Technical endpoints providing access to services operated for the organization
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Organization.extension:purposesofuse.​value[x] | Base | required | Purpose Of Use | 📦1.13.0 | This IG
Organization.address:united-states-address.​state | Base | required | USPS Two Letter Alphabetic Codes | 📦6.1.0 | US Core v6.1

#### Constraints

Id | Grade | Path(s) | Description | Expression
cq-o1 | error | Organization | A Carequailty Organization must have an Organization.type:sequoiaorgtype of Connection or Implementer. | `type.where(coding.where(system='https://sequoiaproject.org/fhir/sphd/CodeSystem/OrganizationType' and code='Connection').exists()).exists() or type.where(coding.where(system='https://sequoiaproject.org/fhir/sphd/CodeSystem/OrganizationType' and code='Implementer').exists()).exists()`

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C | 0..* | SequoiaOrganization | This is an abstract profile. Child profiles: CarequalityConnection, CarequalityImplementer A grouping of people or organizations with a common purpose Constraints: org-1, so-1, so-2, cq-o1
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
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:domains | S | 1..* | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains Binding: Domains (required)
extension:hubservicesubscriptions |  | 0..* | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions Binding: Hub Service Subscriptions (required)
extension:administrativestatus |  | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus Binding: Administrative Status (required)
extension:hubroutingstatus |  | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus Binding: Hub Routing Status (required)
extension:initiatoronly | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly Binding: Initiator Only (required)
extension:org-managing-org | S | 0..1 | Reference(Sequoia Organization) | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org
extension:purposesofuse | S | 0..* | (Complex) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Purpose Of Use (required)
extension:stateofoperation | S | 0..* | Address | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation
extension:usecases | S | 0..* | CodeableConcept | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases Binding: Endpoint Use Case Codes (required)
extension:doa | S | 0..* | Reference(Sequoia Organization) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/DOA
extension:transaction | S | 0..* | CodeableConcept | When used on an organization, this represents initiating transactions URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction Binding: Transactions (required)
extension:delegation-role | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/DelegationRole Binding: Delegation Role Value Set (required)
extension:organization-node-type |  | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrganizationNodeType Binding: Organization Node Type ValueSet (required)
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 | 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
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)
identifier:CCN | S Σ C | 0..1 | Identifier | CMS Certification Number (CCN) 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.336
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:HCID | S Σ C | 1..1 | Identifier | OID (such as a Home Community ID) or UUID 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 |  | 1..1 | CodeableConcept | Description of identifier Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HCID
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986
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:AAID | S Σ C | 0..* | Identifier | OID (such as an Assiging Authority ID) or UUID 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 |  | 1..1 | CodeableConcept | Description of identifier Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AAID
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986
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:TEFCAID | S Σ C | 0..* | Identifier | TEFCA Identifier Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 1..1 | CodeableConcept | Description of identifier Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: TEFCAID
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986
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
Slices for type | S Σ | 1..* | CodeableConcept | Kind of organization Slice: Unordered, Open by pattern:$this Binding: OrganizationType (example): Used to categorize the organization.
type:sequoiaorgtype | S Σ | 1..1 | CodeableConcept | Kind of organization Binding: Organization Type (required)
type:hl7orgrole | S Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationAffiliationRole (required)
name | S Σ C | 1..1 | string | Name used for the organization
alias | S | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past
Slices for telecom | S C | 0..* | ContactPoint | A contact detail for the organization Slice: Unordered, Open by value:system Constraints: org-3
telecom:phone | S C | 0..1 | 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 | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone
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
telecom:email | S C | 0..1 | 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 | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email
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
Slices for address | S C | 1..* | Address | An address for the organization Slice: Unordered, Open by value:country Constraints: org-2
address:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension | S | 1..* | Reference(Sequoia Location) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation 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 | S Σ | 1..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | S Σ | 0..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
country | S Σ | 1..1 | string | Must be an ISO 3166 2 or 3 letter code, with 2 letter codes preferred for compliance with later versions of US Core Organization
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
address:united-states-address | S C | 0..* | Address | An address for the organization Constraints: org-2
id |  | 0..1 | string | Unique id for inter-element referencing
extension | S | 1..* | Reference(Sequoia Location) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation 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 | S Σ | 1..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | S Σ | 0..1 | 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 Σ | 1..1 | string | Name of city, town etc. Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | S Σ | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (required): Two letter USPS alphabetic codes.
postalCode | S Σ | 1..1 | string | US Zip Codes Example General: 9132
country | S Σ | 1..1 | string | Must be an ISO 3166 2 or 3 letter code, with 2 letter codes preferred for compliance with later versions of US Core Organization Fixed Value: US
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
partOf | S Σ | 0..1 | Reference(Carequality Organization) | The organization of which this organization forms a part
contact | S | 0..* | BackboneElement | Contact for the organization for a certain purpose
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:company | S | 0..* | string | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
purpose | S | 1..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
name | S | 1..1 | HumanName | A name associated with the contact
Slices for telecom | S | 2..* | ContactPoint | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:system
telecom:phone | S | 1..* | ContactPoint | Contact details (telephone, email, etc.) for a contact
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone
value | Σ | 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
telecom:email | S | 1..1 | ContactPoint | Contact details (telephone, email, etc.) for a contact
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email
value | Σ | 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 | 0..1 | Address | Visiting or postal addresses for the contact
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 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..1 | 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 | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok)
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
endpoint | S | 0..* | Reference(Carequality 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.extension:purposesofuse.​value[x] | Base | required | Purpose Of Use | 📦1.13.0 | This IG
Organization.type | Base | example | Organization type | 📦4.0.1 | FHIR Std.
Organization.type:sequoiaorgtype | Base | required | Organization Type | 📦1.13.0 | This IG
Organization.type:hl7orgrole | Base | required | Organization Affiliation Role | 📦4.0.1 | FHIR Std.
Organization.telecom:phone.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Organization.telecom:phone.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Organization.telecom:email.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Organization.telecom:email.​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.address:united-states-address.​use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Organization.address:united-states-address.​type | Base | required | AddressType | 📍4.0.1 | FHIR Std.
Organization.address:united-states-address.​state | Base | required | 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.
Organization.contact.​telecom:phone.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Organization.contact.​telecom:phone.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Organization.contact.​telecom:email.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Organization.contact.​telecom:email.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Organization.contact.​address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Organization.contact.​address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
cq-o1 | error | Organization | A Carequailty Organization must have an Organization.type:sequoiaorgtype of Connection or Implementer. | `type.where(coding.where(system='https://sequoiaproject.org/fhir/sphd/CodeSystem/OrganizationType' and code='Connection').exists()).exists() or type.where(coding.where(system='https://sequoiaproject.org/fhir/sphd/CodeSystem/OrganizationType' and code='Implementer').exists()).exists()`
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, Organization.address:united-states-address | An address of an organization can never be of use 'home' | `where(use = 'home').empty()`
org-3 | error | Organization.telecom, Organization.telecom:phone, Organization.telecom:email | The telecom of an organization can never be of use 'home' | `where(use = 'home').empty()`
so-1 | error | Organization | For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier | `endpoint.exists() implies identifier.where(type.coding.first().code='HCID').single().value.substring(8)=id`
so-2 | warning | Organization | If Organization.type:hl7orgrole = 'payer' then Organization.identifier:NAIC is required | `type.where(coding.first().code='payer').exists() implies identifier.where(system='urn:oid:2.16.840.1.113883.6.300').exists()`
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 SequoiaOrganization

Summary

Mandatory: 2 elements(9 nested mandatory elements)
Must-Support: 5 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

- Carequality Organization (https://sequoiaproject.org/fhir/cq/StructureDefinition/CarequalityOrganization)
- Carequality Endpoint (https://sequoiaproject.org/fhir/cq/StructureDefinition/CarequalityEndpoint)

Slices

This structure defines the following Slices:

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

Other representations of profile: CSV, Excel, Schematron