Carequality Healthcare Directory ImplementationGuide
1.18.0 - Release 1

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

Resource Profile: Carequality Connection

Official URL: https://sequoiaproject.org/fhir/cq/StructureDefinition/CarequalityConnection Version: 1.18.0
Active as of 2026-10-27 Computable Name: CarequalityConnection

The Carequality Connection profile represents an organization that participates in exchange activities via Carequality through a Carequality Implementer, such as a health system that participates via its EHR vendor, who is an implementer.

Usages:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Organization C 0..* CarequalityOrganization A grouping of people or organizations with a common purpose
Constraints: org-1, so-1, so-2, so-3, cq-o1
Organization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Organization.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for extension.extension:domains This element must be supported. 1..* Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains
Binding: Domains (required)
Organization.Slices for extension.extension:hubservicesubscriptions 0..* Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions
Binding: Hub Service Subscriptions (required)
Organization.Slices for extension.extension:administrativestatus 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus
Binding: Administrative Status (required)
Organization.Slices for extension.extension:hubroutingstatus 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus
Binding: Hub Routing Status (required)
Organization.Slices for extension.extension:initiatoronly This element must be supported. 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly
Binding: Initiator Only (required)
Organization.Slices for extension.extension:org-managing-org This element must be supported. 1..1 Reference(Sequoia Organization) Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org
Organization.Slices for extension.extension:purposesofuse This element must be supported. 0..* (Complex) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
Organization.Slices for extension.extension:purposesofuse.extension 0..0 Extension
Slice: Unordered, Open by value:url
Organization.Slices for extension.extension:purposesofuse.url 1..1 uri "https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse"
Organization.Slices for extension.extension:purposesofuse.value[x] 1..1 CodeableConcept Value of extension
Binding: Purpose Of Use (required)
Organization.Slices for extension.extension:stateofoperation This element must be supported. 0..* Address Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation
Organization.Slices for extension.extension:usecases This element must be supported. 0..* CodeableConcept Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases
Binding: Endpoint Use Case Codes (required)
Organization.Slices for extension.extension:doa This element must be supported. 0..* Reference(Sequoia Organization) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/DOA
Organization.Slices for extension.extension:transaction This element must be supported. 0..* CodeableConcept When used on an organization, this represents initiating transactions
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction
Binding: Transactions (required)
Organization.Slices for extension.extension:delegation-role This element must be supported. 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/DelegationRole
Binding: Delegation Role Value Set (required)
Organization.Slices for extension.extension:organization-node-type 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrganizationNodeType
Binding: Organization Node Type ValueSet (required)
Organization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Organization.Slices for identifier This element must be supported. This element is included in summaries. C 1..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:NPI This element must be supported. This element is included in summaries. C 0..* Identifier National Provider Identifier (NPI)
Constraints: us-core-16, us-core-17

Required Pattern: 
{
  "system" : "http://hl7.org/fhir/sid/us-npi"
}
Organization.Slices for identifier.identifier:CLIA This element is included in summaries. C 0..* Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
Constraints: us-core-18

Required Pattern: 
{
  "system" : "urn:oid:2.16.840.1.113883.4.7"
}
Organization.Slices for identifier.identifier:NAIC This element must be supported. This element is included in summaries. C 0..* Identifier NAIC Code
Constraints: us-core-19

Required Pattern: 
{
  "system" : "urn:oid:2.16.840.1.113883.6.300"
}
Organization.Slices for identifier.identifier:USEIN This element must be supported. This element is included in summaries. C 0..* Identifier US Employer Identification Number (USEIN), also known as Federal EIN (FEIN)

Required Pattern: 
{
  "system" : "urn:oid:2.16.840.1.113883.4.4"
}
Organization.Slices for identifier.identifier:CCN This element must be supported. This element is included in summaries. C 0..1 Identifier CMS Certification Number (CCN)

Required Pattern: 
{
  "system" : "urn:oid:2.16.840.1.113883.4.336"
}
Organization.Slices for identifier.identifier:HCID This element must be supported. This element is included in summaries. C 1..1 Identifier OID (such as a Home Community ID) or UUID

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
        "code" : "HCID"
      }
    ]
  },
  "system" : "urn:ietf:rfc:3986"
}
Organization.Slices for identifier.identifier:AAID This element must be supported. This element is included in summaries. C 0..* Identifier OID (such as an Assiging Authority ID) or UUID

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
        "code" : "AAID"
      }
    ]
  },
  "system" : "urn:ietf:rfc:3986"
}
Organization.Slices for identifier.identifier:TEFCAID This element must be supported. This element is included in summaries. C 0..* Identifier TEFCA Identifier

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
        "code" : "TEFCAID"
      }
    ]
  },
  "system" : "urn:ietf:rfc:3986"
}
Organization.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether the organization's record is still in active use
Organization.Slices for type This element must be supported. This element is included in summaries. 1..* CodeableConcept Kind of organization
Slice: Unordered, Open by pattern:$this
Binding: OrganizationType (example): Used to categorize the organization.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for type.type:sequoiaorgtype This element must be supported. This element is included in summaries. 1..1 CodeableConcept Kind of organization
Binding: Organization Type (required)

Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/OrganizationType",
      "code" : "Connection"
    }
  ]
}
Organization.Slices for type.type:hl7orgrole This element must be supported. This element is included in summaries. 0..* CodeableConcept Kind of organization
Binding: OrganizationAffiliationRole (required)
Organization.name This element must be supported. This element is included in summaries. C 1..1 string Name used for the organization
Organization.alias This element must be supported. 0..* string A list of alternate names that the organization is known as, or was known as in the past
Organization.Slices for telecom This element must be supported. C 0..* ContactPoint A contact detail for the organization
Slice: Unordered, Open by value:system
Constraints: org-3

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for telecom.telecom:phone This element must be supported. C 0..1 ContactPoint A contact detail for the organization
Constraints: org-3
Organization.Slices for telecom.telecom:phone.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone (no extensions allowed)
Organization.Slices for telecom.telecom:phone.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
Organization.Slices for telecom.telecom:phone.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.Slices for telecom.telecom:email This element must be supported. C 0..1 ContactPoint A contact detail for the organization
Constraints: org-3
Organization.Slices for telecom.telecom:email.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email (no extensions allowed)
Organization.Slices for telecom.telecom:email.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
Organization.Slices for telecom.telecom:email.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.Slices for address This element must be supported. C 1..* Address An address for the organization
Slice: Unordered, Open by value:country
Constraints: org-2

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for address.address:All Slices Content/Rules for all slices
Organization.Slices for address.address:All Slices.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Organization.Slices for address.address:All Slices.Slices for extension.extension:orglocation This element must be supported. 1..* Reference(Sequoia Location) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation
Organization.Slices for address.address:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Organization.Slices for address.address:All Slices.text This element must be supported. This element is included in summaries. 1..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Organization.Slices for address.address:All Slices.line This element must be supported. This element is included in summaries. 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
Organization.Slices for address.address:All Slices.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Organization.Slices for address.address:All Slices.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
Organization.Slices for address.address:All Slices.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Organization.Slices for address.address:All Slices.country This element must be supported. This element is included in summaries. 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
Organization.Slices for address.address:united-states-address This element must be supported. C 0..* Address An address for the organization
Constraints: org-2
Organization.Slices for address.address:united-states-address.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Organization.Slices for address.address:united-states-address.Slices for extension Content/Rules for all slices
Organization.Slices for address.address:united-states-address.Slices for extension.extension:orglocation This element must be supported. 1..* Reference(Sequoia Location) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation
Organization.Slices for address.address:united-states-address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Organization.Slices for address.address:united-states-address.text This element must be supported. This element is included in summaries. 1..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Organization.Slices for address.address:united-states-address.line This element must be supported. This element is included in summaries. 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
Organization.Slices for address.address:united-states-address.city This element must be supported. This element is included in summaries. 1..1 string Name of city, town etc.
Example General: Erewhon
Organization.Slices for address.address:united-states-address.state This element must be supported. This element is included in summaries. 1..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (required): Two letter USPS alphabetic codes.
Organization.Slices for address.address:united-states-address.postalCode This element must be supported. This element is included in summaries. 1..1 string US Zip Codes
Example General: 9132
Organization.Slices for address.address:united-states-address.country This element must be supported. This element is included in summaries. 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 (no extensions allowed)
Organization.partOf This element must be supported. This element is included in summaries. 1..1 Reference(Carequality Organization) The organization of which this organization forms a part
Organization.contact This element must be supported. 0..* BackboneElement Contact for the organization for a certain purpose
Organization.contact.Slices for extension Content/Rules for all slices
Organization.contact.Slices for extension.extension:company This element must be supported. 0..* string Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company
Organization.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Organization.contact.purpose This element must be supported. 1..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
Organization.contact.name This element must be supported. 1..1 HumanName A name associated with the contact
Organization.contact.Slices for telecom This element must be supported. 2..* ContactPoint Contact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.contact.Slices for telecom.telecom:phone This element must be supported. 1..* ContactPoint Contact details (telephone, email, etc.) for a contact
Organization.contact.Slices for telecom.telecom:phone.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone (no extensions allowed)
Organization.contact.Slices for telecom.telecom:phone.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.contact.Slices for telecom.telecom:email This element must be supported. 1..1 ContactPoint Contact details (telephone, email, etc.) for a contact
Organization.contact.Slices for telecom.telecom:email.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email (no extensions allowed)
Organization.contact.Slices for telecom.telecom:email.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.contact.address This element must be supported. 0..1 Address Visiting or postal addresses for the contact
Organization.contact.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Organization.contact.address.line This element must be supported. This element is included in summaries. 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
Organization.endpoint This element must be supported. 0..* Reference(Carequality Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Organization.extension:purposesofuse.​value[x] Base required Purpose Of Use 📦1.18.0 This IG
Organization.type Base example Organization type 📦4.0.1 FHIR Std.
Organization.type:sequoiaorgtype Base required Organization Type 📦1.18.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()
so-3 error Organization USEIN (also known as FEIN) must be 9 digits formatted as XX-XXXXXXX, or have a data-absent-reason of 'masked' identifier.where(system = 'urn:oid:2.16.840.1.113883.4.4').all(value.matches('^[0-9]{2}-[0-9]{7}$') or value.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists(value = 'masked'))
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 CarequalityOrganization

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Organization 0..* CarequalityOrganization A grouping of people or organizations with a common purpose
Organization.extension 2..* Extension Extension
Organization.Slices for extension Content/Rules for all slices
Organization.Slices for extension.extension:org-managing-org 1..1 OrgManagingOrg Optional Extensions Element
Organization.Slices for type Content/Rules for all slices
Organization.Slices for type.type:sequoiaorgtype 1..1 CodeableConcept Kind of organization
Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/OrganizationType",
      "code" : "Connection"
    }
  ]
}

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Organization C 0..* CarequalityOrganization A grouping of people or organizations with a common purpose
Constraints: org-1, so-1, so-2, so-3, cq-o1
Organization.id This element is included in summaries. 0..1 id Logical id of this artifact
Organization.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Organization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Organization.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Organization.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
Organization.contained 0..* Resource Contained, inline Resources
Organization.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for extension.extension:domains This element must be supported. 1..* Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains
Binding: Domains (required)
Organization.Slices for extension.extension:hubservicesubscriptions 0..* Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions
Binding: Hub Service Subscriptions (required)
Organization.Slices for extension.extension:administrativestatus 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus
Binding: Administrative Status (required)
Organization.Slices for extension.extension:hubroutingstatus 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus
Binding: Hub Routing Status (required)
Organization.Slices for extension.extension:initiatoronly This element must be supported. 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly
Binding: Initiator Only (required)
Organization.Slices for extension.extension:org-managing-org This element must be supported. 1..1 Reference(Sequoia Organization) Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org
Organization.Slices for extension.extension:purposesofuse This element must be supported. 0..* (Complex) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
Organization.Slices for extension.extension:purposesofuse.id 0..1 string Unique id for inter-element referencing
Organization.Slices for extension.extension:purposesofuse.extension 0..0 Extension
Slice: Unordered, Open by value:url
Organization.Slices for extension.extension:purposesofuse.url 1..1 uri "https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse"
Organization.Slices for extension.extension:purposesofuse.value[x] 1..1 CodeableConcept Value of extension
Binding: Purpose Of Use (required)
Organization.Slices for extension.extension:stateofoperation This element must be supported. 0..* Address Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation
Organization.Slices for extension.extension:usecases This element must be supported. 0..* CodeableConcept Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases
Binding: Endpoint Use Case Codes (required)
Organization.Slices for extension.extension:doa This element must be supported. 0..* Reference(Sequoia Organization) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/DOA
Organization.Slices for extension.extension:transaction This element must be supported. 0..* CodeableConcept When used on an organization, this represents initiating transactions
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction
Binding: Transactions (required)
Organization.Slices for extension.extension:delegation-role This element must be supported. 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/DelegationRole
Binding: Delegation Role Value Set (required)
Organization.Slices for extension.extension:organization-node-type 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrganizationNodeType
Binding: Organization Node Type ValueSet (required)
Organization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Organization.Slices for identifier This element must be supported. This element is included in summaries. C 1..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:NPI This element must be supported. This element is included in summaries. C 0..* Identifier National Provider Identifier (NPI)
Constraints: us-core-16, us-core-17

Required Pattern: 
{
  "system" : "http://hl7.org/fhir/sid/us-npi"
}
Organization.Slices for identifier.identifier:CLIA This element is included in summaries. C 0..* Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
Constraints: us-core-18

Required Pattern: 
{
  "system" : "urn:oid:2.16.840.1.113883.4.7"
}
Organization.Slices for identifier.identifier:NAIC This element must be supported. This element is included in summaries. C 0..* Identifier NAIC Code
Constraints: us-core-19

Required Pattern: 
{
  "system" : "urn:oid:2.16.840.1.113883.6.300"
}
Organization.Slices for identifier.identifier:USEIN This element must be supported. This element is included in summaries. C 0..* Identifier US Employer Identification Number (USEIN), also known as Federal EIN (FEIN)

Required Pattern: 
{
  "system" : "urn:oid:2.16.840.1.113883.4.4"
}
Organization.Slices for identifier.identifier:CCN This element must be supported. This element is included in summaries. C 0..1 Identifier CMS Certification Number (CCN)

Required Pattern: 
{
  "system" : "urn:oid:2.16.840.1.113883.4.336"
}
Organization.Slices for identifier.identifier:HCID This element must be supported. This element is included in summaries. C 1..1 Identifier OID (such as a Home Community ID) or UUID

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
        "code" : "HCID"
      }
    ]
  },
  "system" : "urn:ietf:rfc:3986"
}
Organization.Slices for identifier.identifier:AAID This element must be supported. This element is included in summaries. C 0..* Identifier OID (such as an Assiging Authority ID) or UUID

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
        "code" : "AAID"
      }
    ]
  },
  "system" : "urn:ietf:rfc:3986"
}
Organization.Slices for identifier.identifier:TEFCAID This element must be supported. This element is included in summaries. C 0..* Identifier TEFCA Identifier

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
        "code" : "TEFCAID"
      }
    ]
  },
  "system" : "urn:ietf:rfc:3986"
}
Organization.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether the organization's record is still in active use
Organization.Slices for type This element must be supported. This element is included in summaries. 1..* CodeableConcept Kind of organization
Slice: Unordered, Open by pattern:$this
Binding: OrganizationType (example): Used to categorize the organization.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for type.type:sequoiaorgtype This element must be supported. This element is included in summaries. 1..1 CodeableConcept Kind of organization
Binding: Organization Type (required)

Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/OrganizationType",
      "code" : "Connection"
    }
  ]
}
Organization.Slices for type.type:hl7orgrole This element must be supported. This element is included in summaries. 0..* CodeableConcept Kind of organization
Binding: OrganizationAffiliationRole (required)
Organization.name This element must be supported. This element is included in summaries. C 1..1 string Name used for the organization
Organization.alias This element must be supported. 0..* string A list of alternate names that the organization is known as, or was known as in the past
Organization.Slices for telecom This element must be supported. C 0..* ContactPoint A contact detail for the organization
Slice: Unordered, Open by value:system
Constraints: org-3

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for telecom.telecom:phone This element must be supported. C 0..1 ContactPoint A contact detail for the organization
Constraints: org-3
Organization.Slices for telecom.telecom:phone.id 0..1 string Unique id for inter-element referencing
Organization.Slices for telecom.telecom:phone.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.Slices for telecom.telecom:phone.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone (no extensions allowed)
Organization.Slices for telecom.telecom:phone.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
Organization.Slices for telecom.telecom:phone.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.Slices for telecom.telecom:phone.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Organization.Slices for telecom.telecom:phone.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Organization.Slices for telecom.telecom:email This element must be supported. C 0..1 ContactPoint A contact detail for the organization
Constraints: org-3
Organization.Slices for telecom.telecom:email.id 0..1 string Unique id for inter-element referencing
Organization.Slices for telecom.telecom:email.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.Slices for telecom.telecom:email.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email (no extensions allowed)
Organization.Slices for telecom.telecom:email.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
Organization.Slices for telecom.telecom:email.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.Slices for telecom.telecom:email.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Organization.Slices for telecom.telecom:email.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Organization.Slices for address This element must be supported. C 1..* Address An address for the organization
Slice: Unordered, Open by value:country
Constraints: org-2

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for address.address:All Slices Content/Rules for all slices
Organization.Slices for address.address:All Slices.id 0..1 string Unique id for inter-element referencing
Organization.Slices for address.address:All Slices.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Organization.Slices for address.address:All Slices.Slices for extension.extension:orglocation This element must be supported. 1..* Reference(Sequoia Location) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation
Organization.Slices for address.address:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Organization.Slices for address.address:All Slices.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Organization.Slices for address.address:All Slices.text This element must be supported. This element is included in summaries. 1..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Organization.Slices for address.address:All Slices.line This element must be supported. This element is included in summaries. 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
Organization.Slices for address.address:All Slices.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Organization.Slices for address.address:All Slices.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Organization.Slices for address.address:All Slices.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
Organization.Slices for address.address:All Slices.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Organization.Slices for address.address:All Slices.country This element must be supported. This element is included in summaries. 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
Organization.Slices for address.address:All Slices.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Organization.Slices for address.address:united-states-address This element must be supported. C 0..* Address An address for the organization
Constraints: org-2
Organization.Slices for address.address:united-states-address.id 0..1 string Unique id for inter-element referencing
Organization.Slices for address.address:united-states-address.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Organization.Slices for address.address:united-states-address.Slices for extension Content/Rules for all slices
Organization.Slices for address.address:united-states-address.Slices for extension.extension:orglocation This element must be supported. 1..* Reference(Sequoia Location) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation
Organization.Slices for address.address:united-states-address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Organization.Slices for address.address:united-states-address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Organization.Slices for address.address:united-states-address.text This element must be supported. This element is included in summaries. 1..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Organization.Slices for address.address:united-states-address.line This element must be supported. This element is included in summaries. 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
Organization.Slices for address.address:united-states-address.city This element must be supported. This element is included in summaries. 1..1 string Name of city, town etc.
Example General: Erewhon
Organization.Slices for address.address:united-states-address.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Organization.Slices for address.address:united-states-address.state This element must be supported. This element is included in summaries. 1..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (required): Two letter USPS alphabetic codes.
Organization.Slices for address.address:united-states-address.postalCode This element must be supported. This element is included in summaries. 1..1 string US Zip Codes
Example General: 9132
Organization.Slices for address.address:united-states-address.country This element must be supported. This element is included in summaries. 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 (no extensions allowed)
Organization.Slices for address.address:united-states-address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Organization.partOf This element must be supported. This element is included in summaries. 1..1 Reference(Carequality Organization) The organization of which this organization forms a part
Organization.contact This element must be supported. 0..* BackboneElement Contact for the organization for a certain purpose
Organization.contact.id 0..1 string Unique id for inter-element referencing
Organization.contact.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Organization.contact.Slices for extension.extension:company This element must be supported. 0..* string Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company
Organization.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Organization.contact.purpose This element must be supported. 1..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
Organization.contact.name This element must be supported. 1..1 HumanName A name associated with the contact
Organization.contact.Slices for telecom This element must be supported. 2..* ContactPoint Contact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.contact.Slices for telecom.telecom:phone This element must be supported. 1..* ContactPoint Contact details (telephone, email, etc.) for a contact
Organization.contact.Slices for telecom.telecom:phone.id 0..1 string Unique id for inter-element referencing
Organization.contact.Slices for telecom.telecom:phone.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.contact.Slices for telecom.telecom:phone.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone (no extensions allowed)
Organization.contact.Slices for telecom.telecom:phone.value This element is included in summaries. 0..1 string The actual contact point details
Organization.contact.Slices for telecom.telecom:phone.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.contact.Slices for telecom.telecom:phone.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Organization.contact.Slices for telecom.telecom:phone.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Organization.contact.Slices for telecom.telecom:email This element must be supported. 1..1 ContactPoint Contact details (telephone, email, etc.) for a contact
Organization.contact.Slices for telecom.telecom:email.id 0..1 string Unique id for inter-element referencing
Organization.contact.Slices for telecom.telecom:email.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.contact.Slices for telecom.telecom:email.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email (no extensions allowed)
Organization.contact.Slices for telecom.telecom:email.value This element is included in summaries. 0..1 string The actual contact point details
Organization.contact.Slices for telecom.telecom:email.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.contact.Slices for telecom.telecom:email.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Organization.contact.Slices for telecom.telecom:email.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Organization.contact.address This element must be supported. 0..1 Address Visiting or postal addresses for the contact
Organization.contact.address.id 0..1 string Unique id for inter-element referencing
Organization.contact.address.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.contact.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Organization.contact.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Organization.contact.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Organization.contact.address.line This element must be supported. This element is included in summaries. 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
Organization.contact.address.city This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Organization.contact.address.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Organization.contact.address.state This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Organization.contact.address.postalCode This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
Organization.contact.address.country This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Organization.contact.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Organization.endpoint This element must be supported. 0..* Reference(Carequality Endpoint) Technical endpoints providing access to services operated for the organization

doco 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.18.0 This IG
Organization.type Base example Organization type 📦4.0.1 FHIR Std.
Organization.type:sequoiaorgtype Base required Organization Type 📦1.18.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()
so-3 error Organization USEIN (also known as FEIN) must be 9 digits formatted as XX-XXXXXXX, or have a data-absent-reason of 'masked' identifier.where(system = 'urn:oid:2.16.840.1.113883.4.4').all(value.matches('^[0-9]{2}-[0-9]{7}$') or value.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists(value = 'masked'))
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 CarequalityOrganization

Summary

Mandatory: 2 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Organization C 0..* CarequalityOrganization A grouping of people or organizations with a common purpose
Constraints: org-1, so-1, so-2, so-3, cq-o1
Organization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Organization.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for extension.extension:domains This element must be supported. 1..* Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains
Binding: Domains (required)
Organization.Slices for extension.extension:hubservicesubscriptions 0..* Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions
Binding: Hub Service Subscriptions (required)
Organization.Slices for extension.extension:administrativestatus 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus
Binding: Administrative Status (required)
Organization.Slices for extension.extension:hubroutingstatus 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus
Binding: Hub Routing Status (required)
Organization.Slices for extension.extension:initiatoronly This element must be supported. 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly
Binding: Initiator Only (required)
Organization.Slices for extension.extension:org-managing-org This element must be supported. 1..1 Reference(Sequoia Organization) Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org
Organization.Slices for extension.extension:purposesofuse This element must be supported. 0..* (Complex) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
Organization.Slices for extension.extension:purposesofuse.extension 0..0 Extension
Slice: Unordered, Open by value:url
Organization.Slices for extension.extension:purposesofuse.url 1..1 uri "https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse"
Organization.Slices for extension.extension:purposesofuse.value[x] 1..1 CodeableConcept Value of extension
Binding: Purpose Of Use (required)
Organization.Slices for extension.extension:stateofoperation This element must be supported. 0..* Address Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation
Organization.Slices for extension.extension:usecases This element must be supported. 0..* CodeableConcept Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases
Binding: Endpoint Use Case Codes (required)
Organization.Slices for extension.extension:doa This element must be supported. 0..* Reference(Sequoia Organization) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/DOA
Organization.Slices for extension.extension:transaction This element must be supported. 0..* CodeableConcept When used on an organization, this represents initiating transactions
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction
Binding: Transactions (required)
Organization.Slices for extension.extension:delegation-role This element must be supported. 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/DelegationRole
Binding: Delegation Role Value Set (required)
Organization.Slices for extension.extension:organization-node-type 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrganizationNodeType
Binding: Organization Node Type ValueSet (required)
Organization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Organization.Slices for identifier This element must be supported. This element is included in summaries. C 1..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:NPI This element must be supported. This element is included in summaries. C 0..* Identifier National Provider Identifier (NPI)
Constraints: us-core-16, us-core-17

Required Pattern: 
{
  "system" : "http://hl7.org/fhir/sid/us-npi"
}
Organization.Slices for identifier.identifier:CLIA This element is included in summaries. C 0..* Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
Constraints: us-core-18

Required Pattern: 
{
  "system" : "urn:oid:2.16.840.1.113883.4.7"
}
Organization.Slices for identifier.identifier:NAIC This element must be supported. This element is included in summaries. C 0..* Identifier NAIC Code
Constraints: us-core-19

Required Pattern: 
{
  "system" : "urn:oid:2.16.840.1.113883.6.300"
}
Organization.Slices for identifier.identifier:USEIN This element must be supported. This element is included in summaries. C 0..* Identifier US Employer Identification Number (USEIN), also known as Federal EIN (FEIN)

Required Pattern: 
{
  "system" : "urn:oid:2.16.840.1.113883.4.4"
}
Organization.Slices for identifier.identifier:CCN This element must be supported. This element is included in summaries. C 0..1 Identifier CMS Certification Number (CCN)

Required Pattern: 
{
  "system" : "urn:oid:2.16.840.1.113883.4.336"
}
Organization.Slices for identifier.identifier:HCID This element must be supported. This element is included in summaries. C 1..1 Identifier OID (such as a Home Community ID) or UUID

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
        "code" : "HCID"
      }
    ]
  },
  "system" : "urn:ietf:rfc:3986"
}
Organization.Slices for identifier.identifier:AAID This element must be supported. This element is included in summaries. C 0..* Identifier OID (such as an Assiging Authority ID) or UUID

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
        "code" : "AAID"
      }
    ]
  },
  "system" : "urn:ietf:rfc:3986"
}
Organization.Slices for identifier.identifier:TEFCAID This element must be supported. This element is included in summaries. C 0..* Identifier TEFCA Identifier

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
        "code" : "TEFCAID"
      }
    ]
  },
  "system" : "urn:ietf:rfc:3986"
}
Organization.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether the organization's record is still in active use
Organization.Slices for type This element must be supported. This element is included in summaries. 1..* CodeableConcept Kind of organization
Slice: Unordered, Open by pattern:$this
Binding: OrganizationType (example): Used to categorize the organization.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for type.type:sequoiaorgtype This element must be supported. This element is included in summaries. 1..1 CodeableConcept Kind of organization
Binding: Organization Type (required)

Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/OrganizationType",
      "code" : "Connection"
    }
  ]
}
Organization.Slices for type.type:hl7orgrole This element must be supported. This element is included in summaries. 0..* CodeableConcept Kind of organization
Binding: OrganizationAffiliationRole (required)
Organization.name This element must be supported. This element is included in summaries. C 1..1 string Name used for the organization
Organization.alias This element must be supported. 0..* string A list of alternate names that the organization is known as, or was known as in the past
Organization.Slices for telecom This element must be supported. C 0..* ContactPoint A contact detail for the organization
Slice: Unordered, Open by value:system
Constraints: org-3

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for telecom.telecom:phone This element must be supported. C 0..1 ContactPoint A contact detail for the organization
Constraints: org-3
Organization.Slices for telecom.telecom:phone.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone (no extensions allowed)
Organization.Slices for telecom.telecom:phone.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
Organization.Slices for telecom.telecom:phone.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.Slices for telecom.telecom:email This element must be supported. C 0..1 ContactPoint A contact detail for the organization
Constraints: org-3
Organization.Slices for telecom.telecom:email.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email (no extensions allowed)
Organization.Slices for telecom.telecom:email.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
Organization.Slices for telecom.telecom:email.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.Slices for address This element must be supported. C 1..* Address An address for the organization
Slice: Unordered, Open by value:country
Constraints: org-2

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for address.address:All Slices Content/Rules for all slices
Organization.Slices for address.address:All Slices.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Organization.Slices for address.address:All Slices.Slices for extension.extension:orglocation This element must be supported. 1..* Reference(Sequoia Location) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation
Organization.Slices for address.address:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Organization.Slices for address.address:All Slices.text This element must be supported. This element is included in summaries. 1..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Organization.Slices for address.address:All Slices.line This element must be supported. This element is included in summaries. 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
Organization.Slices for address.address:All Slices.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Organization.Slices for address.address:All Slices.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
Organization.Slices for address.address:All Slices.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Organization.Slices for address.address:All Slices.country This element must be supported. This element is included in summaries. 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
Organization.Slices for address.address:united-states-address This element must be supported. C 0..* Address An address for the organization
Constraints: org-2
Organization.Slices for address.address:united-states-address.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Organization.Slices for address.address:united-states-address.Slices for extension Content/Rules for all slices
Organization.Slices for address.address:united-states-address.Slices for extension.extension:orglocation This element must be supported. 1..* Reference(Sequoia Location) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation
Organization.Slices for address.address:united-states-address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Organization.Slices for address.address:united-states-address.text This element must be supported. This element is included in summaries. 1..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Organization.Slices for address.address:united-states-address.line This element must be supported. This element is included in summaries. 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
Organization.Slices for address.address:united-states-address.city This element must be supported. This element is included in summaries. 1..1 string Name of city, town etc.
Example General: Erewhon
Organization.Slices for address.address:united-states-address.state This element must be supported. This element is included in summaries. 1..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (required): Two letter USPS alphabetic codes.
Organization.Slices for address.address:united-states-address.postalCode This element must be supported. This element is included in summaries. 1..1 string US Zip Codes
Example General: 9132
Organization.Slices for address.address:united-states-address.country This element must be supported. This element is included in summaries. 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 (no extensions allowed)
Organization.partOf This element must be supported. This element is included in summaries. 1..1 Reference(Carequality Organization) The organization of which this organization forms a part
Organization.contact This element must be supported. 0..* BackboneElement Contact for the organization for a certain purpose
Organization.contact.Slices for extension Content/Rules for all slices
Organization.contact.Slices for extension.extension:company This element must be supported. 0..* string Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company
Organization.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Organization.contact.purpose This element must be supported. 1..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
Organization.contact.name This element must be supported. 1..1 HumanName A name associated with the contact
Organization.contact.Slices for telecom This element must be supported. 2..* ContactPoint Contact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.contact.Slices for telecom.telecom:phone This element must be supported. 1..* ContactPoint Contact details (telephone, email, etc.) for a contact
Organization.contact.Slices for telecom.telecom:phone.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone (no extensions allowed)
Organization.contact.Slices for telecom.telecom:phone.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.contact.Slices for telecom.telecom:email This element must be supported. 1..1 ContactPoint Contact details (telephone, email, etc.) for a contact
Organization.contact.Slices for telecom.telecom:email.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email (no extensions allowed)
Organization.contact.Slices for telecom.telecom:email.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.contact.address This element must be supported. 0..1 Address Visiting or postal addresses for the contact
Organization.contact.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Organization.contact.address.line This element must be supported. This element is included in summaries. 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
Organization.endpoint This element must be supported. 0..* Reference(Carequality Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Organization.extension:purposesofuse.​value[x] Base required Purpose Of Use 📦1.18.0 This IG
Organization.type Base example Organization type 📦4.0.1 FHIR Std.
Organization.type:sequoiaorgtype Base required Organization Type 📦1.18.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()
so-3 error Organization USEIN (also known as FEIN) must be 9 digits formatted as XX-XXXXXXX, or have a data-absent-reason of 'masked' identifier.where(system = 'urn:oid:2.16.840.1.113883.4.4').all(value.matches('^[0-9]{2}-[0-9]{7}$') or value.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists(value = 'masked'))
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 CarequalityOrganization

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Organization 0..* CarequalityOrganization A grouping of people or organizations with a common purpose
Organization.extension 2..* Extension Extension
Organization.Slices for extension Content/Rules for all slices
Organization.Slices for extension.extension:org-managing-org 1..1 OrgManagingOrg Optional Extensions Element
Organization.Slices for type Content/Rules for all slices
Organization.Slices for type.type:sequoiaorgtype 1..1 CodeableConcept Kind of organization
Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/OrganizationType",
      "code" : "Connection"
    }
  ]
}
Organization.partOf 1..1 Reference(Carequality Organization) The organization of which this organization forms a part

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Organization C 0..* CarequalityOrganization A grouping of people or organizations with a common purpose
Constraints: org-1, so-1, so-2, so-3, cq-o1
Organization.id This element is included in summaries. 0..1 id Logical id of this artifact
Organization.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Organization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Organization.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Organization.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
Organization.contained 0..* Resource Contained, inline Resources
Organization.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for extension.extension:domains This element must be supported. 1..* Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains
Binding: Domains (required)
Organization.Slices for extension.extension:hubservicesubscriptions 0..* Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions
Binding: Hub Service Subscriptions (required)
Organization.Slices for extension.extension:administrativestatus 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus
Binding: Administrative Status (required)
Organization.Slices for extension.extension:hubroutingstatus 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus
Binding: Hub Routing Status (required)
Organization.Slices for extension.extension:initiatoronly This element must be supported. 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly
Binding: Initiator Only (required)
Organization.Slices for extension.extension:org-managing-org This element must be supported. 1..1 Reference(Sequoia Organization) Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org
Organization.Slices for extension.extension:purposesofuse This element must be supported. 0..* (Complex) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
Organization.Slices for extension.extension:purposesofuse.id 0..1 string Unique id for inter-element referencing
Organization.Slices for extension.extension:purposesofuse.extension 0..0 Extension
Slice: Unordered, Open by value:url
Organization.Slices for extension.extension:purposesofuse.url 1..1 uri "https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse"
Organization.Slices for extension.extension:purposesofuse.value[x] 1..1 CodeableConcept Value of extension
Binding: Purpose Of Use (required)
Organization.Slices for extension.extension:stateofoperation This element must be supported. 0..* Address Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation
Organization.Slices for extension.extension:usecases This element must be supported. 0..* CodeableConcept Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases
Binding: Endpoint Use Case Codes (required)
Organization.Slices for extension.extension:doa This element must be supported. 0..* Reference(Sequoia Organization) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/DOA
Organization.Slices for extension.extension:transaction This element must be supported. 0..* CodeableConcept When used on an organization, this represents initiating transactions
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction
Binding: Transactions (required)
Organization.Slices for extension.extension:delegation-role This element must be supported. 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/DelegationRole
Binding: Delegation Role Value Set (required)
Organization.Slices for extension.extension:organization-node-type 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrganizationNodeType
Binding: Organization Node Type ValueSet (required)
Organization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Organization.Slices for identifier This element must be supported. This element is included in summaries. C 1..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:NPI This element must be supported. This element is included in summaries. C 0..* Identifier National Provider Identifier (NPI)
Constraints: us-core-16, us-core-17

Required Pattern: 
{
  "system" : "http://hl7.org/fhir/sid/us-npi"
}
Organization.Slices for identifier.identifier:CLIA This element is included in summaries. C 0..* Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
Constraints: us-core-18

Required Pattern: 
{
  "system" : "urn:oid:2.16.840.1.113883.4.7"
}
Organization.Slices for identifier.identifier:NAIC This element must be supported. This element is included in summaries. C 0..* Identifier NAIC Code
Constraints: us-core-19

Required Pattern: 
{
  "system" : "urn:oid:2.16.840.1.113883.6.300"
}
Organization.Slices for identifier.identifier:USEIN This element must be supported. This element is included in summaries. C 0..* Identifier US Employer Identification Number (USEIN), also known as Federal EIN (FEIN)

Required Pattern: 
{
  "system" : "urn:oid:2.16.840.1.113883.4.4"
}
Organization.Slices for identifier.identifier:CCN This element must be supported. This element is included in summaries. C 0..1 Identifier CMS Certification Number (CCN)

Required Pattern: 
{
  "system" : "urn:oid:2.16.840.1.113883.4.336"
}
Organization.Slices for identifier.identifier:HCID This element must be supported. This element is included in summaries. C 1..1 Identifier OID (such as a Home Community ID) or UUID

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
        "code" : "HCID"
      }
    ]
  },
  "system" : "urn:ietf:rfc:3986"
}
Organization.Slices for identifier.identifier:AAID This element must be supported. This element is included in summaries. C 0..* Identifier OID (such as an Assiging Authority ID) or UUID

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
        "code" : "AAID"
      }
    ]
  },
  "system" : "urn:ietf:rfc:3986"
}
Organization.Slices for identifier.identifier:TEFCAID This element must be supported. This element is included in summaries. C 0..* Identifier TEFCA Identifier

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
        "code" : "TEFCAID"
      }
    ]
  },
  "system" : "urn:ietf:rfc:3986"
}
Organization.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether the organization's record is still in active use
Organization.Slices for type This element must be supported. This element is included in summaries. 1..* CodeableConcept Kind of organization
Slice: Unordered, Open by pattern:$this
Binding: OrganizationType (example): Used to categorize the organization.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for type.type:sequoiaorgtype This element must be supported. This element is included in summaries. 1..1 CodeableConcept Kind of organization
Binding: Organization Type (required)

Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/OrganizationType",
      "code" : "Connection"
    }
  ]
}
Organization.Slices for type.type:hl7orgrole This element must be supported. This element is included in summaries. 0..* CodeableConcept Kind of organization
Binding: OrganizationAffiliationRole (required)
Organization.name This element must be supported. This element is included in summaries. C 1..1 string Name used for the organization
Organization.alias This element must be supported. 0..* string A list of alternate names that the organization is known as, or was known as in the past
Organization.Slices for telecom This element must be supported. C 0..* ContactPoint A contact detail for the organization
Slice: Unordered, Open by value:system
Constraints: org-3

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for telecom.telecom:phone This element must be supported. C 0..1 ContactPoint A contact detail for the organization
Constraints: org-3
Organization.Slices for telecom.telecom:phone.id 0..1 string Unique id for inter-element referencing
Organization.Slices for telecom.telecom:phone.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.Slices for telecom.telecom:phone.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone (no extensions allowed)
Organization.Slices for telecom.telecom:phone.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
Organization.Slices for telecom.telecom:phone.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.Slices for telecom.telecom:phone.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Organization.Slices for telecom.telecom:phone.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Organization.Slices for telecom.telecom:email This element must be supported. C 0..1 ContactPoint A contact detail for the organization
Constraints: org-3
Organization.Slices for telecom.telecom:email.id 0..1 string Unique id for inter-element referencing
Organization.Slices for telecom.telecom:email.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.Slices for telecom.telecom:email.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email (no extensions allowed)
Organization.Slices for telecom.telecom:email.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
Organization.Slices for telecom.telecom:email.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.Slices for telecom.telecom:email.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Organization.Slices for telecom.telecom:email.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Organization.Slices for address This element must be supported. C 1..* Address An address for the organization
Slice: Unordered, Open by value:country
Constraints: org-2

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for address.address:All Slices Content/Rules for all slices
Organization.Slices for address.address:All Slices.id 0..1 string Unique id for inter-element referencing
Organization.Slices for address.address:All Slices.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Organization.Slices for address.address:All Slices.Slices for extension.extension:orglocation This element must be supported. 1..* Reference(Sequoia Location) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation
Organization.Slices for address.address:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Organization.Slices for address.address:All Slices.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Organization.Slices for address.address:All Slices.text This element must be supported. This element is included in summaries. 1..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Organization.Slices for address.address:All Slices.line This element must be supported. This element is included in summaries. 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
Organization.Slices for address.address:All Slices.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Organization.Slices for address.address:All Slices.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Organization.Slices for address.address:All Slices.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
Organization.Slices for address.address:All Slices.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Organization.Slices for address.address:All Slices.country This element must be supported. This element is included in summaries. 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
Organization.Slices for address.address:All Slices.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Organization.Slices for address.address:united-states-address This element must be supported. C 0..* Address An address for the organization
Constraints: org-2
Organization.Slices for address.address:united-states-address.id 0..1 string Unique id for inter-element referencing
Organization.Slices for address.address:united-states-address.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Organization.Slices for address.address:united-states-address.Slices for extension Content/Rules for all slices
Organization.Slices for address.address:united-states-address.Slices for extension.extension:orglocation This element must be supported. 1..* Reference(Sequoia Location) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation
Organization.Slices for address.address:united-states-address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Organization.Slices for address.address:united-states-address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Organization.Slices for address.address:united-states-address.text This element must be supported. This element is included in summaries. 1..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Organization.Slices for address.address:united-states-address.line This element must be supported. This element is included in summaries. 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
Organization.Slices for address.address:united-states-address.city This element must be supported. This element is included in summaries. 1..1 string Name of city, town etc.
Example General: Erewhon
Organization.Slices for address.address:united-states-address.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Organization.Slices for address.address:united-states-address.state This element must be supported. This element is included in summaries. 1..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (required): Two letter USPS alphabetic codes.
Organization.Slices for address.address:united-states-address.postalCode This element must be supported. This element is included in summaries. 1..1 string US Zip Codes
Example General: 9132
Organization.Slices for address.address:united-states-address.country This element must be supported. This element is included in summaries. 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 (no extensions allowed)
Organization.Slices for address.address:united-states-address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Organization.partOf This element must be supported. This element is included in summaries. 1..1 Reference(Carequality Organization) The organization of which this organization forms a part
Organization.contact This element must be supported. 0..* BackboneElement Contact for the organization for a certain purpose
Organization.contact.id 0..1 string Unique id for inter-element referencing
Organization.contact.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Organization.contact.Slices for extension.extension:company This element must be supported. 0..* string Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company
Organization.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Organization.contact.purpose This element must be supported. 1..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
Organization.contact.name This element must be supported. 1..1 HumanName A name associated with the contact
Organization.contact.Slices for telecom This element must be supported. 2..* ContactPoint Contact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.contact.Slices for telecom.telecom:phone This element must be supported. 1..* ContactPoint Contact details (telephone, email, etc.) for a contact
Organization.contact.Slices for telecom.telecom:phone.id 0..1 string Unique id for inter-element referencing
Organization.contact.Slices for telecom.telecom:phone.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.contact.Slices for telecom.telecom:phone.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone (no extensions allowed)
Organization.contact.Slices for telecom.telecom:phone.value This element is included in summaries. 0..1 string The actual contact point details
Organization.contact.Slices for telecom.telecom:phone.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.contact.Slices for telecom.telecom:phone.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Organization.contact.Slices for telecom.telecom:phone.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Organization.contact.Slices for telecom.telecom:email This element must be supported. 1..1 ContactPoint Contact details (telephone, email, etc.) for a contact
Organization.contact.Slices for telecom.telecom:email.id 0..1 string Unique id for inter-element referencing
Organization.contact.Slices for telecom.telecom:email.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.contact.Slices for telecom.telecom:email.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: email (no extensions allowed)
Organization.contact.Slices for telecom.telecom:email.value This element is included in summaries. 0..1 string The actual contact point details
Organization.contact.Slices for telecom.telecom:email.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.contact.Slices for telecom.telecom:email.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Organization.contact.Slices for telecom.telecom:email.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Organization.contact.address This element must be supported. 0..1 Address Visiting or postal addresses for the contact
Organization.contact.address.id 0..1 string Unique id for inter-element referencing
Organization.contact.address.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.contact.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Organization.contact.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Organization.contact.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Organization.contact.address.line This element must be supported. This element is included in summaries. 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
Organization.contact.address.city This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Organization.contact.address.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Organization.contact.address.state This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Organization.contact.address.postalCode This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
Organization.contact.address.country This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Organization.contact.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Organization.endpoint This element must be supported. 0..* Reference(Carequality Endpoint) Technical endpoints providing access to services operated for the organization

doco 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.18.0 This IG
Organization.type Base example Organization type 📦4.0.1 FHIR Std.
Organization.type:sequoiaorgtype Base required Organization Type 📦1.18.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()
so-3 error Organization USEIN (also known as FEIN) must be 9 digits formatted as XX-XXXXXXX, or have a data-absent-reason of 'masked' identifier.where(system = 'urn:oid:2.16.840.1.113883.4.4').all(value.matches('^[0-9]{2}-[0-9]{7}$') or value.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists(value = 'masked'))
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 CarequalityOrganization

Summary

Mandatory: 2 elements

 

Other representations of profile: CSV, Excel, Schematron