Recognized Coordinating Entity (RCE) Implementation Guide
1.0.8 - Release 1
Active as of 2024-05-21 |
Definitions for the QHIN resource profile.
Guidance on how to interpret the contents of this table can be found here
0. Organization | |
2. Organization.type:sequoiaorgtype | |
Slice Name | sequoiaorgtype |
Control | 1..1 |
Must Support | true |
Pattern Value | { |
4. Organization.partOf | |
Control | 0..0 |
6. Organization.contact | |
Control | 1..* |
Must Support | true |
Guidance on how to interpret the contents of this table can be found here
0. Organization | |
Definition | A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc. |
Short | A grouping of people or organizations with a common purpose |
Control | 0..* |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) 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 (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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) org-1: The organization SHALL at least have a name or an identifier, and possibly more than one ( (identifier.count() + name.count()) > 0 )so-1: 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: 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() )org-1: The organization SHALL at least have a name or an identifier, and possibly more than one ((identifier.count() + name.count()) > 0) |
2. Organization.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Short | A set of rules under which this content was created |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
4. Organization.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | ExtensionAdditional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 10..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Organization.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
6. Organization.extension:Domains | |
Slice Name | Domains |
Definition | An Extension |
Short | Domains |
Control | 1..* This element is affected by the following invariants: ele-1 |
Type | Extension(Domains) (Extension Type: Coding) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
8. Organization.extension:HubServiceSubscriptions | |
Slice Name | HubServiceSubscriptions |
Definition | An Extension |
Short | HubServiceSubscription |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(Hub Service Subscription) (Extension Type: Coding) |
Is Modifier | false |
Must Support | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
10. Organization.extension:AdministrativeStatus | |
Slice Name | AdministrativeStatus |
Definition | An Extension |
Short | Extension |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Administrative Status) (Extension Type: Coding) |
Is Modifier | false |
Must Support | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
12. Organization.extension:HubRoutingStatus | |
Slice Name | HubRoutingStatus |
Definition | An Extension |
Short | Extension |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Hub Routing Status) (Extension Type: Coding) |
Is Modifier | false |
Must Support | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
14. Organization.extension:InitiatorOnly | |
Slice Name | InitiatorOnly |
Definition | An Extension |
Short | Extension |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Initiator Only) (Extension Type: Coding) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
16. Organization.extension:org-managing-org | |
Slice Name | org-managing-org |
Definition | An Extension |
Short | Extension |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(OrgManagingOrg) (Extension Type: Reference(Sequoia Organization)) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
18. Organization.extension:PurposesOfUse | |
Slice Name | PurposesOfUse |
Definition | An Extension |
Short | Extension |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(Purposes Of Use) (Extension Type: CodeableConcept) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
20. Organization.extension:PurposesOfUse.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Fixed Value | https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse |
22. Organization.extension:PurposesOfUse.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 10..1 |
Binding | The codes SHALL be taken from For codes, see RCE Purpose ValueSet (required to https://sequoiaproject.org/fhir/sphd/ValueSet/RCE-Purpose-VS ) |
Type | CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
24. Organization.extension:StateOfOperation | |
Slice Name | StateOfOperation |
Definition | An Extension |
Short | Extension |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(StateOfOperation) (Extension Type: Address) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
26. Organization.extension:UseCases | |
Slice Name | UseCases |
Definition | An Extension |
Short | Extension |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(UseCases) (Extension Type: CodeableConcept) |
Is Modifier | false |
Must Support | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
28. Organization.extension:DOA | |
Slice Name | DOA |
Definition | An Extension |
Short | Extension |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(Delegation of Authority) (Extension Type: Reference(Sequoia Organization)) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
30. Organization.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Summary | false |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
32. Organization.identifier | |
Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems. |
Short | Identifies this organization across multiple systems |
Comments | NPI preferred. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 10..* This element is affected by the following invariants: org-1 |
Type | Identifier |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Organization.identifier . The slices are unordered and Open, and can be differentiated using the following discriminators: |
34. Organization.identifier:NPI | |
Slice Name | NPI |
Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems. |
Short | National Provider Identifier (NPI)Identifies this organization across multiple systems |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1* This element is affected by the following invariants: org-1 |
Type | Identifier |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
36. Organization.identifier:CLIA | |
Slice Name | CLIA |
Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems. |
Short | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratoriesIdentifies this organization across multiple systems |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1* This element is affected by the following invariants: org-1 |
Type | Identifier |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
38. Organization.identifier:CCN | |
Slice Name | CCN |
Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems. |
Short | CMS Certification Number (CCN)Identifies this organization across multiple systems |
Comments | NPI preferred. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1* This element is affected by the following invariants: org-1 |
Type | Identifier |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
40. Organization.identifier:HCID | |
Slice Name | HCID |
Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems. |
Short | OID (such as a Home Community ID) or UUIDIdentifies this organization across multiple systems |
Comments | NPI preferred. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 10..1* This element is affected by the following invariants: org-1 |
Type | Identifier |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
42. Organization.identifier:AAID | |
Slice Name | AAID |
Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems. |
Short | OID (such as an Assiging Authority ID) or UUIDIdentifies this organization across multiple systems |
Comments | NPI preferred. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* This element is affected by the following invariants: org-1 |
Type | Identifier |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
44. Organization.identifier:NAIC | |
Slice Name | NAIC |
Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems. |
Short | NAIC CodeIdentifies this organization across multiple systems |
Comments | NAIC Company code (sometimes called "NAIC Number" or "cocode") for payers. If Organization.type:hl7orgrole = payer then a NAIC identifier SHOULD be provided. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* This element is affected by the following invariants: org-1, us-core-19 |
Type | Identifier |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) us-core-19: NAIC must be 5 digits ( value.matches('^[0-9]{5}$') ) |
46. Organization.active | |
Definition | Whether the organization's record is still in active use. |
Short | Whether the organization's record is still in active use |
Comments | This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used. This element is labeled as a modifier because it may be used to mark that the resource was created in error. |
Control | 10..1 |
Type | boolean |
Is Modifier | true because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI. |
Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
48. Organization.type | |
Definition | The kind(s) of organization that this is. |
Short | Kind of organization |
Comments | Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality. |
Control | 10..* |
Binding | For example codes, see OrganizationTypehttp://hl7.org/fhir/ValueSet/organization-type (example to http://hl7.org/fhir/ValueSet/organization-type )Used to categorize the organization. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Need to be able to track the kind of organization that this is - different organization types have different uses. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Organization.type . The slices are unordered and Open, and can be differentiated using the following discriminators: |
50. Organization.type:sequoiaorgtype | |
Slice Name | sequoiaorgtype |
Definition | The kind(s) of organization that this is. |
Short | Kind of organization |
Comments | Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality. |
Control | 10..1* |
Binding | The codes SHALL be taken from For example codes, see Organization Typehttp://hl7.org/fhir/ValueSet/organization-type (required to https://sequoiaproject.org/fhir/sphd/ValueSet/OrganizationType ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Need to be able to track the kind of organization that this is - different organization types have different uses. |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
52. Organization.type:hl7orgrole | |
Slice Name | hl7orgrole |
Definition | The kind(s) of organization that this is. |
Short | Kind of organization |
Comments | Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality. |
Control | 0..* |
Binding | The codes SHALL be taken from For example codes, see OrganizationAffiliationRolehttp://hl7.org/fhir/ValueSet/organization-type (required to http://hl7.org/fhir/ValueSet/organization-role ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Need to be able to track the kind of organization that this is - different organization types have different uses. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
54. Organization.name | |
Definition | A name associated with the organization. |
Short | Name used for the organization |
Comments | If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches. |
Control | 10..1 This element is affected by the following invariants: org-1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | Need to use the name as the label of the organization. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
56. Organization.alias | |
Definition | A list of alternate names that the organization is known as, or was known as in the past. |
Short | A list of alternate names that the organization is known as, or was known as in the past |
Comments | There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization. |
Control | 0..* |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Requirements | Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the organization was known by can be very useful. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
58. Organization.telecom | |
Definition | A contact detail for the organization. |
Short | A contact detail for the organization |
Comments | The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself. |
Control | 0..* This element is affected by the following invariants: org-3 |
Type | ContactPoint |
Is Modifier | false |
Must Support | true |
Summary | false |
Requirements | Human contact for the organization. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) org-3: The telecom of an organization can never be of use 'home' ( where(use = 'home').empty() )org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty()) |
Slicing | This element introduces a set of slices on Organization.telecom . The slices are unordered and Open, and can be differentiated using the following discriminators: |
60. Organization.telecom:phone | |
Slice Name | phone |
Definition | A contact detail for the organization. |
Short | A contact detail for the organization |
Comments | The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself. |
Control | 0..1* This element is affected by the following invariants: org-3 |
Type | ContactPoint |
Is Modifier | false |
Must Support | true |
Summary | false |
Requirements | Human contact for the organization. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) org-3: The telecom of an organization can never be of use 'home' ( where(use = 'home').empty() )org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty()) |
62. Organization.telecom:phone.system | |
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. |
Short | phone | fax | email | pager | url | sms | other |
Control | 10..1 This element is affected by the following invariants: cpt-2 |
Binding | The codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 )Telecommunications form for contact point. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Fixed Value | phone |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
64. Organization.telecom:phone.value | |
Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). |
Short | The actual contact point details |
Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | Need to support legacy numbers that are not in a tightly controlled format. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
66. Organization.telecom:phone.use | |
Definition | Identifies the purpose for the contact point. |
Short | home | work | temp | old | mobile - purpose of this contact point |
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old. |
Control | 0..1 |
Binding | The codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 )Use of contact point. |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
68. Organization.telecom:email | |
Slice Name | |
Definition | A contact detail for the organization. |
Short | A contact detail for the organization |
Comments | The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself. |
Control | 0..1* This element is affected by the following invariants: org-3 |
Type | ContactPoint |
Is Modifier | false |
Must Support | true |
Summary | false |
Requirements | Human contact for the organization. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) org-3: The telecom of an organization can never be of use 'home' ( where(use = 'home').empty() )org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty()) |
70. Organization.telecom:email.system | |
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. |
Short | phone | fax | email | pager | url | sms | other |
Control | 10..1 This element is affected by the following invariants: cpt-2 |
Binding | The codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 )Telecommunications form for contact point. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Fixed Value | email |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
72. Organization.telecom:email.value | |
Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). |
Short | The actual contact point details |
Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | Need to support legacy numbers that are not in a tightly controlled format. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
74. Organization.telecom:email.use | |
Definition | Identifies the purpose for the contact point. |
Short | home | work | temp | old | mobile - purpose of this contact point |
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old. |
Control | 0..1 |
Binding | The codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 )Use of contact point. |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
76. Organization.address | |
Definition | An address for the organization. |
Short | An address for the organization |
Comments | Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used. |
Control | 10..* This element is affected by the following invariants: org-2 |
Type | Address |
Is Modifier | false |
Must Support | true |
Summary | false |
Requirements | May need to keep track of the organization's addresses for contacting, billing or reporting requirements. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) org-2: An address of an organization can never be of use 'home' ( where(use = 'home').empty() )org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty()) |
Slicing | This element introduces a set of slices on Organization.address . The slices are unordered and Open, and can be differentiated using the following discriminators: |
78. Organization.address.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Extension |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 1..* |
Type | Extension(Org Location) (Extension Type: Reference(Sequoia Location)) |
Is Modifier | false |
Must Support | true |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
80. Organization.address.use | |
Definition | The purpose of this address. |
Short | home | work | temp | old | billing - purpose of this address |
Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
Control | 0..1 |
Binding | The codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1 )The use of an address. |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows an appropriate address to be chosen from a list of many. |
Example | <br/><b>General</b>:home |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
82. Organization.address.text | |
Definition | Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. |
Short | Text representation of the address |
Comments | Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. |
Control | 10..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | A renderable, unencoded form. |
Example | <br/><b>General</b>:137 Nowhere Street, Erewhon 9132 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
84. Organization.address.line | |
Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. |
Short | Street name, number, direction & P.O. Box etc. |
Control | 0..1* |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Example | <br/><b>General</b>:137 Nowhere Street |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
86. Organization.address.city | |
Definition | The name of the city, town, suburb, village or other community or delivery center. |
Short | Name of city, town etc. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Alternate Names | Municpality |
Example | <br/><b>General</b>:Erewhon |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
88. Organization.address.state | |
Definition | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). |
Short | Sub-unit of country (abbreviations ok) |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from For codes, see USPS Two Letter Alphabetic Codes (extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state )Two letter USPS alphabetic codes. |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Alternate Names | Province, Territory |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
90. Organization.address.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Short | US Zip CodesPostal code for area |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Alternate Names | Zip |
Example | <br/><b>General</b>:9132 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
92. Organization.address.country | |
Definition | Country - a nation as commonly understood or generally accepted. |
Short | Must be an ISO 3166 2 or 3 letter code, with 2 letter codes preferred for compliance with later versions of US Core OrganizationCountry (e.g. can be ISO 3166 2 or 3 letter code) |
Comments | ISO 3166 3 letter codes can be used in place of a human readable country name. |
Control | 10..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
94. Organization.address:united-states-address | |
Slice Name | united-states-address |
Definition | An address for the organization. |
Short | An address for the organization |
Comments | Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used. |
Control | 10..* This element is affected by the following invariants: org-2 |
Type | Address |
Is Modifier | false |
Must Support | true |
Summary | false |
Requirements | May need to keep track of the organization's addresses for contacting, billing or reporting requirements. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) org-2: An address of an organization can never be of use 'home' ( where(use = 'home').empty() )org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty()) |
96. Organization.address:united-states-address.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Extension |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension(Org Location) (Extension Type: Reference(Sequoia Location)) |
Is Modifier | false |
Must Support | true |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
98. Organization.address:united-states-address.use | |
Definition | The purpose of this address. |
Short | home | work | temp | old | billing - purpose of this address |
Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
Control | 0..1 |
Binding | The codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1 )The use of an address. |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows an appropriate address to be chosen from a list of many. |
Example | <br/><b>General</b>:home |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
100. Organization.address:united-states-address.line | |
Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. |
Short | Street name, number, direction & P.O. Box etc. |
Control | 0..1* |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Example | <br/><b>General</b>:137 Nowhere Street |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
102. Organization.address:united-states-address.city | |
Definition | The name of the city, town, suburb, village or other community or delivery center. |
Short | Name of city, town etc. |
Control | 10..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Alternate Names | Municpality |
Example | <br/><b>General</b>:Erewhon |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
104. Organization.address:united-states-address.state | |
Definition | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). |
Short | Sub-unit of country (abbreviations ok) |
Control | 10..1 |
Binding | Unless not suitable, these codes SHALL be taken from For codes, see USPS Two Letter Alphabetic Codes (extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state )Two letter USPS alphabetic cod |