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

Resource Profile: QHIN

Official URL: https://sequoiaproject.org/fhir/rce/StructureDefinition/QHIN Version: 1.2.0
Active as of 2024-12-23 Computable Name: QHIN

The QHIN profile represents a Qualified Health Information Network as defined in the Common Agreement. A QHIN can be the parent of Participant, Subparticipant, and Child organizations. There will be exactly one QHIN Organization resource per Designated QHIN.

The QHIN profile represents a Qualified Health Information Network as defined in the Common Agreement. A QHIN can be the parent of Participant, Subparticipant, and Child organizations. There will be exactly one QHIN Organization resource per Designated QHIN.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* RCEOrganization A grouping of people or organizations with a common purpose
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
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
ele-1: All FHIR elements must have a @value or children
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... domains S 1..* Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains
Binding: Domains (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... hubservicesubscriptions 0..* Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions
Binding: Hub Service Subscriptions (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... administrativestatus 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus
Binding: Administrative Status (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... hubroutingstatus 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus
Binding: Hub Routing Status (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... initiatoronly S 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly
Binding: Initiator Only (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... org-managing-org S 0..1 Reference(Sequoia Organization) Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... purposesofuse S 0..* (Complex) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... 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)
ele-1: All FHIR elements must have a @value or children
.... stateofoperation S 0..* Address Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... usecases 0..* CodeableConcept Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases
Binding: Endpoint Use Case Codes (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... doa S 0..* Reference(Sequoia Organization) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/DOA
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... identifier:NPI SΣC 0..1 Identifier National Provider Identifier (NPI)
ele-1: All FHIR elements must have a @value or children

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
ele-1: All FHIR elements must have a @value or children

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)
ele-1: All FHIR elements must have a @value or children

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
ele-1: All FHIR elements must have a @value or children

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
ele-1: All FHIR elements must have a @value or children

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
ele-1: All FHIR elements must have a @value or children
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
ele-1: All FHIR elements must have a @value or children
... Slices for type SΣ 1..* CodeableConcept Kind of organization
Slice: Unordered, Open by pattern:$this
Binding: OrganizationType (example): Used to categorize the organization.


ele-1: All FHIR elements must have a @value or children
.... type:sequoiaorgtype SΣ 1..1 CodeableConcept Kind of organization
Binding: Organization Type (required)
ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... 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/OrganizationType
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: QHIN
.... type:hl7orgrole SΣ 0..* CodeableConcept Kind of organization
Binding: OrganizationAffiliationRole (required)
ele-1: All FHIR elements must have a @value or children
... name SΣC 1..1 string Name used for the organization
ele-1: All FHIR elements must have a @value or children
... alias S 0..* string A list of alternate names that the organization is known as, or was known as in the past
ele-1: All FHIR elements must have a @value or children
... Slices for telecom SC 0..* ContactPoint A contact detail for the organization
Slice: Unordered, Open by value:system
ele-1: All FHIR elements must have a @value or children
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
ele-1: All FHIR elements must have a @value or children
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.


ele-1: All FHIR elements must have a @value or children
Fixed Value: phone
..... value SΣ 0..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
.... telecom:email SC 0..1 ContactPoint A contact detail for the organization
ele-1: All FHIR elements must have a @value or children
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.


ele-1: All FHIR elements must have a @value or children
Fixed Value: email
..... value SΣ 0..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
... Slices for address SC 1..* Address An address for the organization
Slice: Unordered, Open by value:country
ele-1: All FHIR elements must have a @value or children
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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Example General: home
..... text SΣ 1..1 string Text representation of the address
ele-1: All FHIR elements must have a @value or children
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ 0..1 string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
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.
ele-1: All FHIR elements must have a @value or children
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.


ele-1: All FHIR elements must have a @value or children
..... postalCode SΣ 0..1 string US Zip Codes
ele-1: All FHIR elements must have a @value or children
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
ele-1: All FHIR elements must have a @value or children
.... address:united-states-address SC 1..* Address An address for the organization
ele-1: All FHIR elements must have a @value or children
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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Example General: home
..... line SΣ 0..1 string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
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.
ele-1: All FHIR elements must have a @value or children
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.


ele-1: All FHIR elements must have a @value or children
..... postalCode SΣ 1..1 string US Zip Codes
ele-1: All FHIR elements must have a @value or children
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
ele-1: All FHIR elements must have a @value or children
Fixed Value: US
... contact S 1..* BackboneElement Contact for the organization for a certain purpose
ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... company S 0..* string Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... purpose S 1..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.


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


ele-1: All FHIR elements must have a @value or children
Fixed Value: phone
...... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
..... telecom:email S 1..1 ContactPoint Contact details (telephone, email, etc.) for a contact
ele-1: All FHIR elements must have a @value or children
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Fixed Value: email
...... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
.... address S 0..1 Address Visiting or postal addresses for the contact
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Example General: home
..... line SΣ 0..1 string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
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
ele-1: All FHIR elements must have a @value or children

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:sequoiaorgtyperequiredPattern: QHIN
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}$')

 

Other representations of profile: CSV, Excel, Schematron