Profile Information - C4BB Organization

This profile builds upon the US Core Organization profile. It is used to convey a payer, provider, payee or service facility organization.

Status

active as of 2022-11-28

Publisher

HL7 Financial Management Working Group

Version

2.0.0

FHIR Version

4.0.1

Copyright

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.
Control 0..*
Summary False

Organization.id

Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Control 0..1
Summary True
Type http://hl7.org/fhirpath/System.String

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.
Control 1..1
Summary True
Type Meta

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.
Control 0..1
Summary False
Type http://hl7.org/fhirpath/System.String

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.
Control 0..*
Summary False
Alternate Names extensions, user content
Type Extension

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.
Control 0..1
Summary True
Type id

Organization.meta.lastUpdated

Definition When the resource last changed - e.g. when the version changed.
Control 0..1
Summary True
Type instant

Organization.meta.source

Definition A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](http://hl7.org/fhir/R4/provenance.html#) 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.
Control 0..1
Summary True
Type uri

Organization.meta.profile

Definition A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/R4/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/R4/structuredefinition-definitions.html#StructureDefinition.url).
Control 1..*
Summary True
Type canonical

Organization.meta.security

Definition Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Control 0..*
Summary True
Type Coding

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.
Control 0..*
Summary True
Type Coding

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.
Control 0..1
Summary True
Type uri

Organization.language

Definition The base language in which the resource is written.
Control 0..1
Summary False
Type code

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.
Control 0..1
Summary False
Alternate Names narrative, html, xhtml, display
Type Narrative

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.
Control 0..*
Summary False
Alternate Names inline resources, anonymous resources, contained resources
Type Resource

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.
Control 0..*
Summary False
Alternate Names extensions, user content
Type Extension

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).
Control 0..*
Summary False
Alternate Names extensions, user content
Type Extension

Organization.identifier

Definition Identifier for the organization that is used to identify the organization across multiple disparate systems.
Control 0..*
Summary True
Type Identifier

Organization.identifier:NPI

Definition Identifier for the organization that is used to identify the organization across multiple disparate systems.
Control 0..1
Summary True
Type Identifier

Organization.identifier:CLIA

Definition Identifier for the organization that is used to identify the organization across multiple disparate systems.
Control 0..1
Summary True
Type Identifier

Organization.identifier:tax

Definition Identifier for the organization that is used to identify the organization across multiple disparate systems.
Control 0..*
Summary True
Type Identifier

Organization.identifier:payerid

Definition Identifier for the organization that is used to identify the organization across multiple disparate systems.
Control 0..*
Summary True
Type Identifier

Organization.identifier:naiccode

Definition Identifier for the organization that is used to identify the organization across multiple disparate systems.
Control 0..*
Summary True
Type Identifier

Organization.active

Definition Whether the organization's record is still in active use.
Control 1..1
Summary True
Type boolean

Organization.type

Definition The kind(s) of organization that this is.
Control 0..*
Summary True
Type CodeableConcept

Organization.name

Definition A name associated with the organization.
Control 1..1
Summary True
Type string

Organization.alias

Definition A list of alternate names that the organization is known as, or was known as in the past.
Control 0..*
Summary False
Type string

Organization.telecom

Definition A contact detail for the organization.
Control 0..*
Summary False
Type ContactPoint

Organization.address

Definition An address for the organization.
Control 0..*
Summary False
Type Address

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.
Control 0..1
Summary False
Type http://hl7.org/fhirpath/System.String

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.
Control 0..*
Summary False
Alternate Names extensions, user content
Type Extension

Organization.address.use

Definition The purpose of this address.
Control 0..1
Summary True
Type code

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.
Control 0..1
Summary True
Type code

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.
Control 0..1
Summary True
Type string

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.
Control 0..4
Summary True
Type string

Organization.address.city

Definition The name of the city, town, suburb, village or other community or delivery center.
Control 0..1
Summary True
Alternate Names Municpality
Type string

Organization.address.district

Definition The name of the administrative area (county).
Control 0..1
Summary True
Alternate Names County
Type string

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).
Control 0..1
Summary True
Alternate Names Province, Territory
Type string

Organization.address.postalCode

Definition A postal code designating a region defined by the postal service.
Control 0..1
Summary True
Alternate Names Zip
Type string

Organization.address.country

Definition Country - a nation as commonly understood or generally accepted.
Control 0..1
Summary True
Type string

Organization.address.period

Definition Time period when address was/is in use.
Control 0..1
Summary True
Type Period

Organization.partOf

Definition The organization of which this organization forms a part.
Control 0..1
Summary True
Type Reference

Organization.contact

Definition Contact for the organization for a certain purpose.
Control 0..*
Summary False
Type BackboneElement

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.
Control 0..1
Summary False
Type http://hl7.org/fhirpath/System.String

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.
Control 0..*
Summary False
Alternate Names extensions, user content
Type Extension

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).
Control 0..*
Summary True
Alternate Names extensions, user content, modifiers
Type Extension

Organization.contact.purpose

Definition Indicates a purpose for which the contact can be reached.
Control 0..1
Summary False
Type CodeableConcept

Organization.contact.name

Definition A name associated with the contact.
Control 0..1
Summary False
Type HumanName

Organization.contact.telecom

Definition A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.
Control 0..*
Summary False
Type ContactPoint

Organization.contact.address

Definition Visiting or postal addresses for the contact.
Control 0..1
Summary False
Type Address

Organization.endpoint

Definition Technical endpoints providing access to services operated for the organization.
Control 0..*
Summary False
Type Reference

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*USCoreOrganizationProfileA grouping of people or organizations with a common purpose
uncontained-requires-lastUpdated: meta.lastUpdated required if not a contained resource
organization-meta-profile-version: Organization: meta.profile with canonical and major.minor. version required.
... meta S1..1MetaMetadata about the resource
.... lastUpdated S0..1instantWhen the resource version last changed
.... profile 1..*canonical(StructureDefinition)Profiles this resource claims to conform to
... identifier:NPI 0..1IdentifierNational Provider Identifier (NPI)
Required Pattern: At least the following
.... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
.... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
... identifier:tax S0..*IdentifierTax ID Number

Required Pattern: At least the following
.... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: TAX
.... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.4
... identifier:payerid S0..*IdentifierPayer ID used in HIPAA covered claims submission transactions

Required Pattern: At least the following
.... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: payerid
... identifier:naiccode S0..*IdentifierNAIC Code

Required Pattern: At least the following
.... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: naiccode
.... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.6.300
... address 0..*AddressAn address for the organization

doco Documentation for this format