CARIN Digital Insurance Card
2.0.0-ballot - STU 2 Ballot

CARIN Digital Insurance Card - Downloaded Version 2.0.0-ballot See the Directory of published versions

## Resource Profile: C4DICOrganization - Detailed Descriptions

Page standards status: Trial-use | Maturity Level: 2

Definitions for the C4DIC-Organization resource profile.

- Differential Elements Table
- Key Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. Organization
2. Organization.meta
Control | 1..?
Must Support | true
4. Organization.meta.lastUpdated
Comments | Defines the date the Resource was created or updated, whichever comes last. Payers SHALL provide the last time the data was updated or the date of creation in the payer’s system of record, whichever comes last. Apps will use the meta.lastUpdated value to determine if the Reference resources are as of the current date or date of service.
Control | 1..?
Must Support | true
6. Organization.meta.profile
Comments | meta.profile is required as a matter of convenience of receiving systems. The meta.profile should be used by the Server to hint/assert/declare that this instance conforms to one (or more) stated profiles (with business versions). meta.profile does not capture any business logic, processing directives, or semantics. Clients should not assume that the Server will exhaustively indicate all profiles with all versions that this instance conforms to. Clients can (and should) perform their own validation of conformance to the indicated profile(s) and to any other profiles of interest.
Control | 1..?
Slicing | This element introduces a set of slices on `Organization.meta.profile`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ $this
8. Organization.meta.profile:supportedProfile
Slice Name | supportedProfile
Control | 1..1
Pattern Value | `http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Organization`
10. Organization.identifier:CLIA
Slice Name | CLIA
Note | This is a business identifier, not a resource identifier (see discussion)
Must Support | true
12. Organization.identifier:NAIC
Slice Name | NAIC
Note | This is a business identifier, not a resource identifier (see discussion)
Must Support | true
14. Organization.identifier:payerid
Slice Name | payerid
Short | Payer ID
Comments | Internal value assigned by the payer responsible for the coverage
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Must Support | true
Pattern Value | `{ "type" : { "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/C4DICIdentifierType", "code" : "payerid" }] } }`
16. Organization.contact
Must Support | true
18. Organization.contact.purpose
Binding | Unless not suitable, these codes SHALL be taken from C4DIC Contact Type (extensible to `http://hl7.org/fhir/us/insurance-card/ValueSet/C4DICContactTypeVS` )
20. Organization.contact.telecom
Must Support | true
22. Organization.contact.address
Must Support | true

Guidance on how to interpret the contents of this table can be foundhere

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
Comments | -
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`) 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.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 10..1
Type | Meta
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Organization.meta.lastUpdated
Definition | When the resource last changed - e.g. when the version changed.
Short | When the resource version last changed
Comments | Defines the date the Resource was created or updated, whichever comes last. Payers SHALL provide the last time the data was updated or the date of creation in the payer’s system of record, whichever comes last. Apps will use the meta.lastUpdated value to determine if the Reference resources are as of the current date or date of service. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
Control | 10..1
Type | instant
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()))
6. Organization.meta.profile
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
Short | Profiles this resource claims to conform to
Comments | meta.profile is required as a matter of convenience of receiving systems. The meta.profile should be used by the Server to hint/assert/declare that this instance conforms to one (or more) stated profiles (with business versions). meta.profile does not capture any business logic, processing directives, or semantics. Clients should not assume that the Server will exhaustively indicate all profiles with all versions that this instance conforms to. Clients can (and should) perform their own validation of conformance to the indicated profile(s) and to any other profiles of interest. It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
Control | 10..*
Type | canonical(StructureDefinition)
Is Modifier | false
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()))
Slicing | This element introduces a set of slices on `Organization.meta.profile`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ $this
8. Organization.meta.profile:supportedProfile
Slice Name | supportedProfile
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
Short | Profiles this resource claims to conform to
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
Control | 10..1*
Type | canonical(StructureDefinition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Pattern Value | `http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Organization`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. 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()))
12. 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())
14. 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 | 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.
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 areUnordered and Open, and can be differentiated using the following discriminators: pattern @ $this
16. 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..* This element is affected by the following invariants: org-1, us-core-16, us-core-17
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 | `{ "system" : "http://hl7.org/fhir/sid/us-npi" }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) us-core-16: NPI must be 10 digits (`value.matches('^[0-9]{10}$')`) us-core-17: NPI check digit must be valid (Luhn algorithm check) (`(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)`)
18. 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..* This element is affected by the following invariants: org-1, us-core-18
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 | `{ "system" : "urn:oid:2.16.840.1.113883.4.7" }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) us-core-18: CLIA number must be 10 digits with a letter "D" in third position (`value.matches('^[0-9]{2}D[0-9]{7}$')`)
20. 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.
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 | `{ "system" : "urn:oid:2.16.840.1.113883.6.300" }`
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}$')`)
22. Organization.identifier:payerid
Slice Name | payerid
Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems.
Short | Payer IDIdentifies this organization across multiple systems
Comments | Internal value assigned by the payer responsible for the coverage
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 | `{ "type" : { "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/C4DICIdentifierType", "code" : "payerid" }] } }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. 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()))
26. 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()))
28. 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())
30. Organization.telecom.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 | 0..1 This element is affected by the following invariants: cpt-2
Binding | The codes SHALL be taken from ContactPointSystem http://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
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Organization.telecom.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()))
34. Organization.telecom.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 ContactPointUse http://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()))
36. 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 | 0..* 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())
38. 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 AddressUse http://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 | General: home
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. 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..4*
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 | General: 137 Nowhere Street
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. 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 | General: Erewhon
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. 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()))
46. 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 | General: 9132
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. Organization.address.country
Definition | Country - a nation as commonly understood or generally accepted.
Short | Country (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 | 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
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. Organization.contact
Definition | Contact for the organization for a certain purpose.
Short | Contact for the organization for a certain purpose
Comments | Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Requirements | Need to keep track of assigned contact points within bigger organization.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. Organization.contact.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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 even if unrecognized
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 element that contains them
Summary | true
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, modifiers
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())
54. Organization.contact.purpose
Definition | Indicates a purpose for which the contact can be reached.
Short | The type of contact
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from C4DIC Contact Type http://hl7.org/fhir/ValueSet/contactentity-type|4.0.1 (extensible to `http://hl7.org/fhir/us/insurance-card/ValueSet/C4DICContactTypeVS` )
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Need to distinguish between multiple contact persons.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. Organization.contact.telecom
Definition | A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.
Short | Contact details (telephone, email, etc.) for a contact
Control | 0..*
Type | ContactPoint
Is Modifier | false
Must Support | true
Summary | false
Requirements | People have (primary) ways to contact them in some way such as phone, email.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. Organization.contact.address
Definition | Visiting or postal addresses for the contact.
Short | Visiting or postal addresses for the contact
Control | 0..1
Type | Address
Is Modifier | false
Must Support | true
Summary | false
Requirements | May need to keep track of a contact party's address for contacting, billing or reporting requirements.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Organization
Definition | -
Short | A grouping of people or organizations with a common purpose
Comments | -
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`)
2. Organization.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Control | 0..1
Type | id
Is Modifier | false
Summary | true
4. Organization.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 1..1
Type | Meta
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. Organization.meta.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
8. Organization.meta.extension
Definition | 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 | Additional 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 | 0..*
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.meta.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
10. Organization.meta.versionId
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
Short | Version specific identifier
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
Control | 0..1
Type | id
Is Modifier | false
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())`)
12. Organization.meta.lastUpdated
Definition | When the resource last changed - e.g. when the version changed.
Short | When the resource version last changed
Comments | Defines the date the Resource was created or updated, whichever comes last. Payers SHALL provide the last time the data was updated or the date of creation in the payer’s system of record, whichever comes last. Apps will use the meta.lastUpdated value to determine if the Reference resources are as of the current date or date of service.
Control | 1..1
Type | instant
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())`)
14. Organization.meta.source
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
Short | Identifies where the resource comes from
Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
Control | 0..1
Type | uri
Is Modifier | false
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())`)
16. Organization.meta.profile
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
Short | Profiles this resource claims to conform to
Comments | meta.profile is required as a matter of convenience of receiving systems. The meta.profile should be used by the Server to hint/assert/declare that this instance conforms to one (or more) stated profiles (with business versions). meta.profile does not capture any business logic, processing directives, or semantics. Clients should not assume that the Server will exhaustively indicate all profiles with all versions that this instance conforms to. Clients can (and should) perform their own validation of conformance to the indicated profile(s) and to any other profiles of interest.
Control | 1..*
Type | canonical(StructureDefinition)
Is Modifier | false
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())`)
Slicing | This element introduces a set of slices on `Organization.meta.profile`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ $this
18. Organization.meta.profile:supportedProfile
Slice Name | supportedProfile
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
Short | Profiles this resource claims to conform to
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
Control | 1..1
Type | canonical(StructureDefinition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Pattern Value | `http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Organization`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
20. Organization.meta.security
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Short | Security Labels applied to this resource
Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Control | 0..*
Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to `http://hl7.org/fhir/ValueSet/security-labels|4.0.1` ) Security Labels from the Healthcare Privacy and Security Classification System.
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. Organization.meta.tag
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
Short | Tags applied to this resource
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Control | 0..*
Binding | For example codes, see CommonTags (example to `http://hl7.org/fhir/ValueSet/common-tags|4.0.1` ) Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
24. 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())`)
26. Organization.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
28. Organization.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Short | Text summary of the resource, for human interpretation
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Control | 0..1
Type | Narrative
Is Modifier | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. Organization.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Control | 0..*
Type | Resource
Is Modifier | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
32. Organization.extension
Definition | 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 | Additional 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 | 0..*
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()`)
34. 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()`)
36. 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 | 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.
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 areUnordered and Open, and can be differentiated using the following discriminators: pattern @ $this
38. 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)
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-16, us-core-17
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 | `{ "system" : "http://hl7.org/fhir/sid/us-npi" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) us-core-16: NPI must be 10 digits (`value.matches('^[0-9]{10}$')`) us-core-17: NPI check digit must be valid (Luhn algorithm check) (`(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)`)
40. 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 laboratories
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-18
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 | `{ "system" : "urn:oid:2.16.840.1.113883.4.7" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) us-core-18: CLIA number must be 10 digits with a letter "D" in third position (`value.matches('^[0-9]{2}D[0-9]{7}$')`)
42. Organization.identifier:NAIC
Slice Name | NAIC
Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems.
Short | NAIC Code
Comments | NAIC Company code (sometimes called "NAIC Number" or "cocode") for payers.
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 | `{ "system" : "urn:oid:2.16.840.1.113883.6.300" }`
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}$')`)
44. Organization.identifier:payerid
Slice Name | payerid
Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems.
Short | Payer ID
Comments | Internal value assigned by the payer responsible for the coverage
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 | `{ "type" : { "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/C4DICIdentifierType", "code" : "payerid" }] } }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
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 | 1..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 | 0..*
Binding | For example codes, see OrganizationType (example to `http://hl7.org/fhir/ValueSet/organization-type` ) Used to categorize the organization.
Type | CodeableConcept
Is Modifier | false
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())`)
50. 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 | 1..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())`)
52. 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
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())`)
54. 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()`)
56. Organization.telecom.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
58. Organization.telecom.extension
Definition | 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 | Additional 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 | 0..*
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.telecom.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
60. Organization.telecom.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 | 0..1 This element is affected by the following invariants: cpt-2
Binding | The codes SHALL be taken from ContactPointSystem (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
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
62. Organization.telecom.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())`)
64. Organization.telecom.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 ContactPointUse (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())`)
66. Organization.telecom.rank
Definition | Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Short | Specify preferred order of use (1 = highest)
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Control | 0..1
Type | positiveInt
Is Modifier | false
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())`)
68. Organization.telecom.period
Definition | Time period when the contact point was/is in use.
Short | Time period when the contact point was/is in use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
70. 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 | 0..* 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()`)
72. Organization.address.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
74. Organization.address.extension
Definition | 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 | Additional 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 | 0..*
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.address.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
76. 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 AddressUse (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 | General: home
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
78. Organization.address.type
Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
Short | postal | physical | both
Comments | The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).
Control | 0..1
Binding | The codes SHALL be taken from AddressType (required to `http://hl7.org/fhir/ValueSet/address-type|4.0.1` ) The type of an address (physical / postal).
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: both
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
80. 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 | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | A renderable, unencoded form.
Example | General: 137 Nowhere Street, Erewhon 9132
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
82. 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..4
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 | General: 137 Nowhere Street
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
84. 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 | General: Erewhon
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
86. Organization.address.district
Definition | The name of the administrative area (county).
Short | District name (aka county)
Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | County
Example | General: Madison
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 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 Codes
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 | General: 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 | Country (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 | 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
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
94. Organization.address.period
Definition | Time period when address was/is in use.
Short | Time period when address was/is in use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Requirements | Allows addresses to be placed in historical context.
Example | General: { "start" : "2010-03-23", "end" : "2010-07-01" }
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
96. Organization.partOf
Definition | The organization of which this organization forms a part.
Short | The organization of which this organization forms a part
Control | 0..1
Type | Reference(Organization)
Is Modifier | false
Summary | true
Requirements | Need to be able to track the hierarchy of organizations within an organization.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
98. Organization.contact
Definition | Contact for the organization for a certain purpose.
Short | Contact for the organization for a certain purpose
Comments | Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Requirements | Need to keep track of assigned contact points within bigger organization.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
100. Organization.contact.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
102. Organization.contact.extension
Definition | 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 | Additional 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 | 0..*
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()`)
104. Organization.contact.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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 even if unrecognized
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 element that contains them
Summary | true
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, modifiers
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()`)
106. Organization.contact.purpose
Definition | Indicates a purpose for which the contact can be reached.
Short | The type of contact
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from C4DIC Contact Type (extensible to `http://hl7.org/fhir/us/insurance-card/ValueSet/C4DICContactTypeVS` )
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Need to distinguish between multiple contact persons.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
108. Organization.contact.name
Definition | A name associated with the contact.
Short | A name associated with the contact
Control | 0..1
Type | HumanName
Is Modifier | false
Summary | false
Requirements | Need to be able to track the person by name.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
110. Organization.contact.telecom
Definition | A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.
Short | Contact details (telephone, email, etc.) for a contact
Control | 0..*
Type | ContactPoint
Is Modifier | false
Must Support | true
Summary | false
Requirements | People have (primary) ways to contact them in some way such as phone, email.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
112. Organization.contact.address
Definition | Visiting or postal addresses for the contact.
Short | Visiting or postal addresses for the contact
Control | 0..1
Type | Address
Is Modifier | false
Must Support | true
Summary | false
Requirements | May need to keep track of a contact party's address for contacting, billing or reporting requirements.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
114. Organization.endpoint
Definition | Technical endpoints providing access to services operated for the organization.
Short | Technical endpoints providing access to services operated for the organization
Control | 0..*
Type | Reference(Endpoint)
Is Modifier | false
Summary | false
Requirements | Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)