Recognized Coordinating Entity (RCE) Implementation Guide
1.0.10 - Release 1

Resource Profile: RCE Organization ( Abstract )

Official URL: https://sequoiaproject.org/fhir/rce/StructureDefinition/RCE-Organization Version: 1.0.10
Active as of 2024-08-30 Computable Name: RCEOrganization

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

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

Usage:

Formal Views of Profile Content

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

This structure is derived from SequoiaOrganization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..* SequoiaOrganization This is an abstractprofile. Childprofiles: Child, Participant, QHIN, Subparticipant
A grouping of people or organizations with a common purpose
... Slices for extension Content/Rules for all slices
.... extension:purposesofuse 0..* PurposesOfUse Extension
..... value[x] 1..1 CodeableConcept Value of extension
Binding: RCE Purpose ValueSet (required)
... Slices for telecom Content/Rules for all slices
.... telecom:phone 0..1 ContactPoint A contact detail for the organization
.... telecom:email 0..1 ContactPoint A contact detail for the organization
... Slices for address 1..* Address An address for the organization
Slice: Unordered, Open by value:country
.... address:All Slices Content/Rules for all slices
..... extension 1..* OrgLocation Extension
..... text S 1..1 string Text representation of the address
..... country 1..1 string Must be an ISO 3166 2 or 3 letter code, with 2 letter codes preferred for compliance with later versions of US Core Organization
.... address:united-states-address S 1..* Address An address for the organization
..... city 1..1 string Name of city, town etc.
..... state 1..1 string Sub-unit of country (abbreviations ok)
..... postalCode 1..1 string US Zip Codes
..... country 0..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
... contact
.... purpose S 1..1 CodeableConcept The type of contact
.... name S 1..1 HumanName A name associated with the contact
.... telecom 2..* ContactPoint Contact details (telephone, email, etc.) for a contact
.... Slices for telecom Content/Rules for all slices
..... telecom:phone 1..* ContactPoint Contact details (telephone, email, etc.) for a contact
.... Slices for telecom Content/Rules for all slices
..... telecom:email 1..1 ContactPoint Contact details (telephone, email, etc.) for a contact
... endpoint 0..* Reference(RCE Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organization.extension:purposesofuse.value[x]requiredRCEPurposeVS
https://sequoiaproject.org/fhir/sphd/ValueSet/RCEPurposeVS
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* SequoiaOrganization This is an abstractprofile. Childprofiles: Child, Participant, QHIN, Subparticipant
A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
so-1: For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier
so-2: If Organization.type:hl7orgrole = 'payer' then Organization.identifier:NAIC is required
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... domains S 1..* Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains
Binding: Domains (required)
.... hubservicesubscriptions 0..* Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions
Binding: Hub Service Subscriptions (required)
.... administrativestatus 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus
Binding: Administrative Status (required)
.... hubroutingstatus 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus
Binding: Hub Routing Status (required)
.... initiatoronly S 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly
Binding: Initiator Only (required)
.... org-managing-org S 0..1 Reference(Sequoia Organization) Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org
.... purposesofuse S 0..* (Complex) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
..... extension 0..0
..... url 1..1 uri "https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: RCE Purpose ValueSet (required)
.... stateofoperation S 0..* Address Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation
.... usecases 0..* CodeableConcept Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases
Binding: Endpoint Use Case Codes (required)
.... doa S 0..* Reference(Sequoia Organization) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/DOA
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:NPI SΣC 0..1 Identifier National Provider Identifier (NPI)

Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
.... identifier:CLIA ΣC 0..1 Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories

Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7
.... identifier:CCN SΣC 0..1 Identifier CMS Certification Number (CCN)

Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.336
.... identifier:HCID SΣC 1..1 Identifier OID (such as a Home Community ID) or UUID

Required Pattern: At least the following
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: HCID
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... identifier:AAID SΣC 0..* Identifier OID (such as an Assiging Authority ID) or UUID

Required Pattern: At least the following
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: AAID
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... identifier:NAIC SΣC 0..* Identifier NAIC Code
us-core-19: NAIC must be 5 digits

Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.6.300
... active ?!SΣ 1..1 boolean Whether the organization's record is still in active use
... Slices for type SΣ 1..* CodeableConcept Kind of organization
Slice: Unordered, Open by pattern:$this
Binding: OrganizationType (example): Used to categorize the organization.


.... type:sequoiaorgtype SΣ 1..1 CodeableConcept Kind of organization
Binding: Organization Type (required)
.... type:hl7orgrole SΣ 0..* CodeableConcept Kind of organization
Binding: OrganizationAffiliationRole (required)
... name SΣC 1..1 string Name used for the organization
... alias S 0..* string A list of alternate names that the organization is known as, or was known as in the past
... Slices for telecom SC 0..* ContactPoint A contact detail for the organization
Slice: Unordered, Open by value:system
org-3: The telecom of an organization can never be of use 'home'
.... telecom:phone SC 0..1 ContactPoint A contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... telecom:email SC 0..1 ContactPoint A contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
..... value SΣ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... Slices for address SC 1..* Address An address for the organization
Slice: Unordered, Open by value:country
org-2: An address of an organization can never be of use 'home'
.... address:All Slices Content/Rules for all slices
..... OrgLocation S 1..* Reference(Sequoia Location) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... text SΣ 1..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

..... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
..... country SΣ 1..1 string Must be an ISO 3166 2 or 3 letter code, with 2 letter codes preferred for compliance with later versions of US Core Organization
.... address:united-states-address SC 1..* Address An address for the organization
org-2: An address of an organization can never be of use 'home'
..... OrgLocation S 0..* Reference(Sequoia Location) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... line SΣ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 1..1 string Name of city, town etc.
Example General: Erewhon
..... state SΣ 1..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

..... postalCode SΣ 1..1 string US Zip Codes
Example General: 9132
..... country SΣ 0..1 string Must be an ISO 3166 2 or 3 letter code, with 2 letter codes preferred for compliance with later versions of US Core Organization
Fixed Value: US
... partOf SΣ 0..1 Reference(RCE Organization) The organization of which this organization forms a part
... contact S 0..* BackboneElement Contact for the organization for a certain purpose
.... Slices for extension Content/Rules for all slices
..... company S 0..* string Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... purpose S 1..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name S 1..1 HumanName A name associated with the contact
.... Slices for telecom S 2..* ContactPoint Contact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system
..... telecom:phone S 1..* ContactPoint Contact details (telephone, email, etc.) for a contact
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
...... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... telecom:email S 1..1 ContactPoint Contact details (telephone, email, etc.) for a contact
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
...... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... address S 0..1 Address Visiting or postal addresses for the contact
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... line SΣ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
... endpoint S 0..* Reference(RCE Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.extension:purposesofuse.value[x]requiredRCEPurposeVS
https://sequoiaproject.org/fhir/sphd/ValueSet/RCEPurposeVS
from this IG
Organization.typeexampleOrganizationType
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.type:sequoiaorgtyperequiredOrganizationType
https://sequoiaproject.org/fhir/sphd/ValueSet/OrganizationType
from this IG
Organization.type:hl7orgrolerequiredOrganizationAffiliationRole
http://hl7.org/fhir/ValueSet/organization-role
from the FHIR Standard
Organization.telecom:phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.telecom:email.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Organization.address:united-states-address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address:united-states-address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard
Organization.contact.telecom:phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.contact.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.contact.telecom:email.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.contact.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.contact.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.address, Organization.address:united-states-addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecom, Organization.telecom:phone, Organization.telecom:emailThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
so-1warningOrganizationFor 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-2warningOrganizationIf Organization.type:hl7orgrole = 'payer' then Organization.identifier:NAIC is required
: type.where(coding.first().code='payer').exists() implies identifier.where(system='urn:oid:2.16.840.1.113883.6.300').exists()
us-core-19errorOrganization.identifier:NAICNAIC must be 5 digits
: value.matches('^[0-9]{5}$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* SequoiaOrganization This is an abstractprofile. Childprofiles: Child, Participant, QHIN, Subparticipant
A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
so-1: For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier
so-2: If Organization.type:hl7orgrole = 'payer' then Organization.identifier:NAIC is required
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... domains S 1..* Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains
Binding: Domains (required)
.... hubservicesubscriptions 0..* Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions
Binding: Hub Service Subscriptions (required)
.... administrativestatus 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus
Binding: Administrative Status (required)
.... hubroutingstatus 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus
Binding: Hub Routing Status (required)
.... initiatoronly S 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly
Binding: Initiator Only (required)
.... org-managing-org S 0..1 Reference(Sequoia Organization) Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org
.... purposesofuse S 0..* (Complex) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: RCE Purpose ValueSet (required)
.... stateofoperation S 0..* Address Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation
.... usecases 0..* CodeableConcept Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases
Binding: Endpoint Use Case Codes (required)
.... doa S 0..* Reference(Sequoia Organization) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/DOA
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣC 1..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI SΣC 0..1 Identifier National Provider Identifier (NPI)

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:CLIA ΣC 0..1 Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:CCN SΣC 0..1 Identifier CMS Certification Number (CCN)

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.336
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:HCID SΣC 1..1 Identifier OID (such as a Home Community ID) or UUID

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: HCID
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:AAID SΣC 0..* Identifier OID (such as an Assiging Authority ID) or UUID

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: AAID
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:NAIC SΣC 0..* Identifier NAIC Code
us-core-19: NAIC must be 5 digits

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.6.300
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!SΣ 1..1 boolean Whether the organization's record is still in active use
... Slices for type SΣ 1..* CodeableConcept Kind of organization
Slice: Unordered, Open by pattern:$this
Binding: OrganizationType (example): Used to categorize the organization.


.... type:sequoiaorgtype SΣ 1..1 CodeableConcept Kind of organization
Binding: Organization Type (required)
.... type:hl7orgrole SΣ 0..* CodeableConcept Kind of organization
Binding: OrganizationAffiliationRole (required)
... name SΣC 1..1 string Name used for the organization
... alias S 0..* string A list of alternate names that the organization is known as, or was known as in the past
... Slices for telecom SC 0..* ContactPoint A contact detail for the organization
Slice: Unordered, Open by value:system
org-3: The telecom of an organization can never be of use 'home'
.... telecom:phone SC 0..1 ContactPoint A contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:email SC 0..1 ContactPoint A contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
..... value SΣ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
... Slices for address SC 1..* Address An address for the organization
Slice: Unordered, Open by value:country
org-2: An address of an organization can never be of use 'home'
.... address:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... OrgLocation S 1..* Reference(Sequoia Location) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
..... text SΣ 1..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... district Σ 0..1 string District name (aka county)
Example General: Madison
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

..... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
..... country SΣ 1..1 string Must be an ISO 3166 2 or 3 letter code, with 2 letter codes preferred for compliance with later versions of US Core Organization
..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... address:united-states-address SC 1..* Address An address for the organization
org-2: An address of an organization can never be of use 'home'
..... id 0..1 string Unique id for inter-element referencing
..... OrgLocation S 0..* Reference(Sequoia Location) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
..... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 1..1 string Name of city, town etc.
Example General: Erewhon
..... district Σ 0..1 string District name (aka county)
Example General: Madison
..... state SΣ 1..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

..... postalCode SΣ 1..1 string US Zip Codes
Example General: 9132
..... country SΣ 0..1 string Must be an ISO 3166 2 or 3 letter code, with 2 letter codes preferred for compliance with later versions of US Core Organization
Fixed Value: US
..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf SΣ 0..1 Reference(RCE Organization) The organization of which this organization forms a part
... contact S 0..* BackboneElement Contact for the organization for a certain purpose
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... company S 0..* string Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... purpose S 1..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name S 1..1 HumanName A name associated with the contact
.... Slices for telecom S 2..* ContactPoint Contact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system
..... telecom:phone S 1..* ContactPoint Contact details (telephone, email, etc.) for a contact
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
...... value Σ 0..1 string The actual contact point details
...... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

...... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
...... period Σ 0..1 Period Time period when the contact point was/is in use
..... telecom:email S 1..1 ContactPoint Contact details (telephone, email, etc.) for a contact
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
...... value Σ 0..1 string The actual contact point details
...... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

...... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
...... period Σ 0..1 Period Time period when the contact point was/is in use
.... address S 0..1 Address Visiting or postal addresses for the contact
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
..... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
..... district Σ 0..1 string District name (aka county)
Example General: Madison
..... state Σ 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode Σ 0..1 string Postal code for area
Example General: 9132
..... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... endpoint S 0..* Reference(RCE Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Organization.extension:purposesofuse.value[x]requiredRCEPurposeVS
https://sequoiaproject.org/fhir/sphd/ValueSet/RCEPurposeVS
from this IG
Organization.typeexampleOrganizationType
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.type:sequoiaorgtyperequiredOrganizationType
https://sequoiaproject.org/fhir/sphd/ValueSet/OrganizationType
from this IG
Organization.type:hl7orgrolerequiredOrganizationAffiliationRole
http://hl7.org/fhir/ValueSet/organization-role
from the FHIR Standard
Organization.telecom:phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.telecom:email.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Organization.address:united-states-address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address:united-states-address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Organization.address:united-states-address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard
Organization.contact.telecom:phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.contact.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.contact.telecom:email.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.contact.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.contact.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.contact.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.address, Organization.address:united-states-addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecom, Organization.telecom:phone, Organization.telecom:emailThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
so-1warningOrganizationFor 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-2warningOrganizationIf Organization.type:hl7orgrole = 'payer' then Organization.identifier:NAIC is required
: type.where(coding.first().code='payer').exists() implies identifier.where(system='urn:oid:2.16.840.1.113883.6.300').exists()
us-core-19errorOrganization.identifier:NAICNAIC must be 5 digits
: value.matches('^[0-9]{5}$')

This structure is derived from SequoiaOrganization

Summary

Mandatory: 8 elements(4 nested mandatory elements)
Must-Support: 4 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from SequoiaOrganization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..* SequoiaOrganization This is an abstractprofile. Childprofiles: Child, Participant, QHIN, Subparticipant
A grouping of people or organizations with a common purpose
... Slices for extension Content/Rules for all slices
.... extension:purposesofuse 0..* PurposesOfUse Extension
..... value[x] 1..1 CodeableConcept Value of extension
Binding: RCE Purpose ValueSet (required)
... Slices for telecom Content/Rules for all slices
.... telecom:phone 0..1 ContactPoint A contact detail for the organization
.... telecom:email 0..1 ContactPoint A contact detail for the organization
... Slices for address 1..* Address An address for the organization
Slice: Unordered, Open by value:country
.... address:All Slices Content/Rules for all slices
..... extension 1..* OrgLocation Extension
..... text S 1..1 string Text representation of the address
..... country 1..1 string Must be an ISO 3166 2 or 3 letter code, with 2 letter codes preferred for compliance with later versions of US Core Organization
.... address:united-states-address S 1..* Address An address for the organization
..... city 1..1 string Name of city, town etc.
..... state 1..1 string Sub-unit of country (abbreviations ok)
..... postalCode 1..1 string US Zip Codes
..... country 0..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
... contact
.... purpose S 1..1 CodeableConcept The type of contact
.... name S 1..1 HumanName A name associated with the contact
.... telecom 2..* ContactPoint Contact details (telephone, email, etc.) for a contact
.... Slices for telecom Content/Rules for all slices
..... telecom:phone 1..* ContactPoint Contact details (telephone, email, etc.) for a contact
.... Slices for telecom Content/Rules for all slices
..... telecom:email 1..1 ContactPoint Contact details (telephone, email, etc.) for a contact
... endpoint 0..* Reference(RCE Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organization.extension:purposesofuse.value[x]requiredRCEPurposeVS
https://sequoiaproject.org/fhir/sphd/ValueSet/RCEPurposeVS
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* SequoiaOrganization This is an abstractprofile. Childprofiles: Child, Participant, QHIN, Subparticipant
A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
so-1: For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier
so-2: If Organization.type:hl7orgrole = 'payer' then Organization.identifier:NAIC is required
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... domains S 1..* Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains
Binding: Domains (required)
.... hubservicesubscriptions 0..* Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions
Binding: Hub Service Subscriptions (required)
.... administrativestatus 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus
Binding: Administrative Status (required)
.... hubroutingstatus 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus
Binding: Hub Routing Status (required)
.... initiatoronly S 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly
Binding: Initiator Only (required)
.... org-managing-org S 0..1 Reference(Sequoia Organization) Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org
.... purposesofuse S 0..* (Complex) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
..... extension 0..0
..... url 1..1 uri "https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: RCE Purpose ValueSet (required)
.... stateofoperation S 0..* Address Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation
.... usecases 0..* CodeableConcept Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases
Binding: Endpoint Use Case Codes (required)
.... doa S 0..* Reference(Sequoia Organization) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/DOA
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:NPI SΣC 0..1 Identifier National Provider Identifier (NPI)

Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
.... identifier:CLIA ΣC 0..1 Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories

Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7
.... identifier:CCN SΣC 0..1 Identifier CMS Certification Number (CCN)

Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.336
.... identifier:HCID SΣC 1..1 Identifier OID (such as a Home Community ID) or UUID

Required Pattern: At least the following
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: HCID
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... identifier:AAID SΣC 0..* Identifier OID (such as an Assiging Authority ID) or UUID

Required Pattern: At least the following
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: AAID
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... identifier:NAIC SΣC 0..* Identifier NAIC Code
us-core-19: NAIC must be 5 digits

Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.6.300
... active ?!SΣ 1..1 boolean Whether the organization's record is still in active use
... Slices for type SΣ 1..* CodeableConcept Kind of organization
Slice: Unordered, Open by pattern:$this
Binding: OrganizationType (example): Used to categorize the organization.


.... type:sequoiaorgtype SΣ 1..1 CodeableConcept Kind of organization
Binding: Organization Type (required)
.... type:hl7orgrole SΣ 0..* CodeableConcept Kind of organization
Binding: OrganizationAffiliationRole (required)
... name SΣC 1..1 string Name used for the organization
... alias S 0..* string A list of alternate names that the organization is known as, or was known as in the past
... Slices for telecom SC 0..* ContactPoint A contact detail for the organization
Slice: Unordered, Open by value:system
org-3: The telecom of an organization can never be of use 'home'
.... telecom:phone SC 0..1 ContactPoint A contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... telecom:email SC 0..1 ContactPoint A contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
..... value SΣ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... Slices for address SC 1..* Address An address for the organization
Slice: Unordered, Open by value:country
org-2: An address of an organization can never be of use 'home'
.... address:All Slices Content/Rules for all slices
..... OrgLocation S 1..* Reference(Sequoia Location) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... text SΣ 1..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

..... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
..... country SΣ 1..1 string Must be an ISO 3166 2 or 3 letter code, with 2 letter codes preferred for compliance with later versions of US Core Organization
.... address:united-states-address SC 1..* Address An address for the organization
org-2: An address of an organization can never be of use 'home'
..... OrgLocation S 0..* Reference(Sequoia Location) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... line SΣ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 1..1 string Name of city, town etc.
Example General: Erewhon
..... state SΣ 1..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

..... postalCode SΣ 1..1 string US Zip Codes
Example General: 9132
..... country SΣ 0..1 string Must be an ISO 3166 2 or 3 letter code, with 2 letter codes preferred for compliance with later versions of US Core Organization
Fixed Value: US
... partOf SΣ 0..1 Reference(RCE Organization) The organization of which this organization forms a part
... contact S 0..* BackboneElement Contact for the organization for a certain purpose
.... Slices for extension Content/Rules for all slices
..... company S 0..* string Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... purpose S 1..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name S 1..1 HumanName A name associated with the contact
.... Slices for telecom S 2..* ContactPoint Contact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system
..... telecom:phone S 1..* ContactPoint Contact details (telephone, email, etc.) for a contact
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
...... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... telecom:email S 1..1 ContactPoint Contact details (telephone, email, etc.) for a contact
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
...... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... address S 0..1 Address Visiting or postal addresses for the contact
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... line SΣ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
... endpoint S 0..* Reference(RCE Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.extension:purposesofuse.value[x]requiredRCEPurposeVS
https://sequoiaproject.org/fhir/sphd/ValueSet/RCEPurposeVS
from this IG
Organization.typeexampleOrganizationType
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.type:sequoiaorgtyperequiredOrganizationType
https://sequoiaproject.org/fhir/sphd/ValueSet/OrganizationType
from this IG
Organization.type:hl7orgrolerequiredOrganizationAffiliationRole
http://hl7.org/fhir/ValueSet/organization-role
from the FHIR Standard
Organization.telecom:phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.telecom:email.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Organization.address:united-states-address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address:united-states-address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard
Organization.contact.telecom:phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.contact.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.contact.telecom:email.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.contact.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.contact.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.address, Organization.address:united-states-addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecom, Organization.telecom:phone, Organization.telecom:emailThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
so-1warningOrganizationFor 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-2warningOrganizationIf Organization.type:hl7orgrole = 'payer' then Organization.identifier:NAIC is required
: type.where(coding.first().code='payer').exists() implies identifier.where(system='urn:oid:2.16.840.1.113883.6.300').exists()
us-core-19errorOrganization.identifier:NAICNAIC must be 5 digits
: value.matches('^[0-9]{5}$')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* SequoiaOrganization This is an abstractprofile. Childprofiles: Child, Participant, QHIN, Subparticipant
A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
so-1: For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier
so-2: If Organization.type:hl7orgrole = 'payer' then Organization.identifier:NAIC is required
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... domains S 1..* Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains
Binding: Domains (required)
.... hubservicesubscriptions 0..* Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions
Binding: Hub Service Subscriptions (required)
.... administrativestatus 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus
Binding: Administrative Status (required)
.... hubroutingstatus 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus
Binding: Hub Routing Status (required)
.... initiatoronly S 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly
Binding: Initiator Only (required)
.... org-managing-org S 0..1 Reference(Sequoia Organization) Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org
.... purposesofuse S 0..* (Complex) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
..... id 0..1 string Unique id for inter-element referencing
.....