This page is part of the CARIN Blue Button Implementation Guide (v2.1.0: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization | Version: 2.1.0 | |||
| Standards status: Trial-use | Computable Name: C4BBOrganization | |||
This profile builds upon the US Core Organization profile. It is used to convey a payer, provider, payee or service facility organization.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints  | 
|---|---|---|---|---|
|   Organization | C | 0..* | USCoreOrganizationProfile(6.1.0) | A grouping of people or organizations with a common purpose This profile also complies with the profile US Core Organization Profile (3.1.1) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management org-1: The organization SHALL at least have a name or an identifier, and possibly more than one 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 | SΣ | 1..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children | 
|     lastUpdated | SΣ | 0..1 | instant | When the resource version last changed ele-1: All FHIR elements must have a @value or children | 
|     profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children | 
|    implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | 
|    modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | 
|    Slices for identifier | SΣC | 0..* | Identifier | Identifies this organization  across multiple systems Slice: Unordered, Open by pattern:$this ele-1: All FHIR elements must have a @value or children | 
|     identifier:NPI | SΣC | 0..* | Identifier | National Provider Identifier (NPI) ele-1: All FHIR elements must have a @value or children us-core-16: NPI must be 10 digits us-core-17: NPI check digit must be valid (Luhn algorithm check) Required Pattern: At least the following | 
|      type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
|       coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
|        system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
|        code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NPI | |
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
|     identifier:CLIA | ΣC | 0..* | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories ele-1: All FHIR elements must have a @value or children us-core-18: CLIA number must be 10 digits with a letter "D" in third position Required Pattern: At least the following | 
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7 | |
|     identifier:NAIC | SΣC | 0..* | Identifier | NAIC Code ele-1: All FHIR elements must have a @value or children us-core-19: NAIC must be 5 digits Required Pattern: At least the following | 
|      type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
|       coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
|        system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType | |
|        code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: naiccode | |
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.300 | |
|     identifier:tax | SΣC | 0..* | Identifier | Tax ID Number ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | 
|      type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
|       coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
|        system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
|        code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: TAX | |
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.4 | |
|     identifier:payerid | SΣC | 0..* | Identifier | Payer ID used in HIPAA covered claims submission transactions ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | 
|      type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
|       coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
|        system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType | |
|        code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: payerid | |
|    active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use ele-1: All FHIR elements must have a @value or children | 
|    name | SΣC | 1..1 | string | Name used for the organization ele-1: All FHIR elements must have a @value or children | 
|    telecom | SC | 0..* | ContactPoint | A contact detail for the organization ele-1: All FHIR elements must have a @value or children org-3: The telecom of an organization can never be of use 'home' | 
|     system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children | 
|     value | SΣ | 0..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children | 
|     use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children | 
|    address | SC | 0..* | Address | An address for the organization ele-1: All FHIR elements must have a @value or children org-2: An address of an organization can never be of use 'home' | 
|     use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home | 
|     line | SΣ | 0..4 | string | Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | 
|     city | SΣ | 0..1 | string | Name of city, town etc. ele-1: All FHIR elements must have a @value or children Example General: Erewhon | 
|     state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. ele-1: All FHIR elements must have a @value or children | 
|     postalCode | SΣ | 0..1 | string | US Zip Codes ele-1: All FHIR elements must have a @value or children Example General: 9132 | 
|     country | SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) ele-1: All FHIR elements must have a @value or children | 
|  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| Organization.telecom.system | required | ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| Organization.telecom.use | required | ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | |
| Organization.address.use | required | AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | |
| Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state | 
| Id | Grade | Path(s) | Details | Requirements | 
| organization-meta-profile-version | warning | Organization | Organization: meta.profile with canonical and major.minor. version required. : meta.profile.exists($this.startsWith('http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization|2.1')) | |
| uncontained-requires-lastUpdated | error | Organization | meta.lastUpdated required if not a contained resource : %resource = %rootResource implies meta.lastUpdated.exists() | |
| us-core-18 | error | Organization.identifier:CLIA | CLIA number must be 10 digits with a letter "D" in third position : value.matches('^[0-9]{2}D[0-9]{7}$') | 
This structure is derived from USCoreOrganizationProfile
| Name | Flags | Card. | Type | Description & Constraints  | 
|---|---|---|---|---|
|   Organization | C | 0..* | USCoreOrganizationProfile(6.1.0) | A grouping of people or organizations with a common purpose This profile also complies with the profile US Core Organization Profile (3.1.1) 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 | S | 1..1 | Meta | Metadata about the resource | 
|     lastUpdated | S | 0..1 | instant | When the resource version last changed | 
|     profile | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
|    Slices for identifier | Content/Rules for all slices | |||
|     identifier:NPI | 0..* | Identifier | National Provider Identifier (NPI) Required Pattern: At least the following | |
|      type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
|       coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
|        system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
|        code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NPI | |
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
|     identifier:NAIC | S | 0..* | Identifier | NAIC Code Required Pattern: At least the following | 
|      type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
|       coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
|        system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType | |
|        code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: naiccode | |
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.300 | |
|     identifier:tax | S | 0..* | Identifier | Tax ID Number Required Pattern: At least the following | 
|      type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
|       coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
|        system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
|        code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: TAX | |
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.4 | |
|     identifier:payerid | S | 0..* | Identifier | Payer ID used in HIPAA covered claims submission transactions Required Pattern: At least the following | 
|      type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
|       coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
|        system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType | |
|        code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: payerid | |
|    address | 0..* | Address | An address for the organization | |
|  Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements | 
| organization-meta-profile-version | warning | Organization | Organization: meta.profile with canonical and major.minor. version required. : meta.profile.exists($this.startsWith('http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization|2.1')) | |
| uncontained-requires-lastUpdated | error | Organization | meta.lastUpdated required if not a contained resource : %resource = %rootResource implies meta.lastUpdated.exists() | 
| Name | Flags | Card. | Type | Description & Constraints  | ||||
|---|---|---|---|---|---|---|---|---|
|   Organization | C | 0..* | USCoreOrganizationProfile(6.1.0) | A grouping of people or organizations with a common purpose This profile also complies with the profile US Core Organization Profile (3.1.1) org-1: The organization SHALL at least have a name or an identifier, and possibly more than one 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. | ||||
|    id | Σ | 0..1 | id | Logical id of this artifact | ||||
|    meta | SΣ | 1..1 | Meta | Metadata about the resource | ||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|     versionId | Σ | 0..1 | id | Version specific identifier | ||||
|     lastUpdated | SΣ | 0..1 | instant | When the resource version last changed | ||||
|     source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
|     profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
|     security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
|     tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
|    implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|    language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
 | |||||
|    text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
|    contained | 0..* | Resource | Contained, inline Resources | |||||
|    extension | 0..* | Extension | Additional content defined by implementations | |||||
|    modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
|    Slices for identifier | SΣC | 0..* | Identifier | Identifies this organization  across multiple systems Slice: Unordered, Open by pattern:$this | ||||
|     identifier:NPI | SΣC | 0..* | Identifier | National Provider Identifier (NPI) us-core-16: NPI must be 10 digits us-core-17: NPI check digit must be valid (Luhn algorithm check) Required Pattern: At least the following | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations | |||||
|      use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
|      type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
|       id | 0..1 | string | Unique id for inter-element referencing | |||||
|       extension | 0..* | Extension | Additional content defined by implementations | |||||
|       coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
|        id | 0..1 | string | Unique id for inter-element referencing | |||||
|        extension | 0..* | Extension | Additional content defined by implementations | |||||
|        system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
|        version | 0..1 | string | Version of the system - if relevant | |||||
|        code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NPI | |||||
|        display | 0..1 | string | Representation defined by the system | |||||
|        userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
|       text | 0..1 | string | Plain text representation of the concept | |||||
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |||||
|      value | 0..1 | string | The value that is unique | |||||
|      period | 0..1 | Period | Time period when id is/was valid for use | |||||
|      assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
|     identifier:CLIA | ΣC | 0..* | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories us-core-18: CLIA number must be 10 digits with a letter "D" in third position Required Pattern: At least the following | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations | |||||
|      use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
|      type | 0..1 | CodeableConcept | Description of identifier | |||||
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7 | |||||
|      value | 0..1 | string | The value that is unique | |||||
|      period | 0..1 | Period | Time period when id is/was valid for use | |||||
|      assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
|     identifier:NAIC | SΣC | 0..* | Identifier | NAIC Code us-core-19: NAIC must be 5 digits Required Pattern: At least the following | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations | |||||
|      use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
|      type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
|       id | 0..1 | string | Unique id for inter-element referencing | |||||
|       extension | 0..* | Extension | Additional content defined by implementations | |||||
|       coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
|        id | 0..1 | string | Unique id for inter-element referencing | |||||
|        extension | 0..* | Extension | Additional content defined by implementations | |||||
|        system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType | |||||
|        version | 0..1 | string | Version of the system - if relevant | |||||
|        code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: naiccode | |||||
|        display | 0..1 | string | Representation defined by the system | |||||
|        userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
|       text | 0..1 | string | Plain text representation of the concept | |||||
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.300 | |||||
|      value | 0..1 | string | The value that is unique | |||||
|      period | 0..1 | Period | Time period when id is/was valid for use | |||||
|      assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
|     identifier:tax | SΣC | 0..* | Identifier | Tax ID Number Required Pattern: At least the following | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations | |||||
|      use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
|      type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
|       id | 0..1 | string | Unique id for inter-element referencing | |||||
|       extension | 0..* | Extension | Additional content defined by implementations | |||||
|       coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
|        id | 0..1 | string | Unique id for inter-element referencing | |||||
|        extension | 0..* | Extension | Additional content defined by implementations | |||||
|        system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
|        version | 0..1 | string | Version of the system - if relevant | |||||
|        code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: TAX | |||||
|        display | 0..1 | string | Representation defined by the system | |||||
|        userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
|       text | 0..1 | string | Plain text representation of the concept | |||||
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.4 | |||||
|      value | 0..1 | string | The value that is unique | |||||
|      period | 0..1 | Period | Time period when id is/was valid for use | |||||
|      assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
|     identifier:payerid | SΣC | 0..* | Identifier | Payer ID used in HIPAA covered claims submission transactions Required Pattern: At least the following | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations | |||||
|      use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
|      type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
|       id | 0..1 | string | Unique id for inter-element referencing | |||||
|       extension | 0..* | Extension | Additional content defined by implementations | |||||
|       coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
|        id | 0..1 | string | Unique id for inter-element referencing | |||||
|        extension | 0..* | Extension | Additional content defined by implementations | |||||
|        system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType | |||||
|        version | 0..1 | string | Version of the system - if relevant | |||||
|        code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: payerid | |||||
|        display | 0..1 | string | Representation defined by the system | |||||
|        userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
|       text | 0..1 | string | Plain text representation of the concept | |||||
|      system | 0..1 | uri | The namespace for the identifier value | |||||
|      value | 0..1 | string | The value that is unique | |||||
|      period | 0..1 | Period | Time period when id is/was valid for use | |||||
|      assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
|    active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use | ||||
|    type | Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example): Used to categorize the organization. | ||||
|    name | SΣC | 1..1 | string | Name used for the organization | ||||
|    alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
|    telecom | SC | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' | ||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|     system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
|     value | SΣ | 0..1 | string | The actual contact point details | ||||
|     use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
|     rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
|     period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
|    address | SC | 0..* | Address | An address for the organization org-2: An address of an organization can never be of use 'home' | ||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|     use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
|     type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
|     text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
|     line | SΣ | 0..4 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
|     city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
|     district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
|     state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. | ||||
|     postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 | ||||
|     country | SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
|     period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
|    partOf | Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part | ||||
|    contact | 0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations | |||||
|     modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
|     purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
|     name | 0..1 | HumanName | A name associated with the contact | |||||
|     telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.)  for a contact | |||||
|     address | 0..1 | Address | Visiting or postal addresses for the contact | |||||
|    endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
|  Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Organization.meta.security | extensible | All Security Labels http://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Organization.meta.tag | example | CommonTags http://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| Organization.language | preferred | CommonLanguages http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard 
 | ||||
| Organization.type | example | OrganizationType http://hl7.org/fhir/ValueSet/organization-typefrom the FHIR Standard | ||||
| Organization.telecom.system | required | ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| Organization.telecom.use | required | ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| Organization.address.use | required | AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | ||||
| Organization.address.type | required | AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1from the FHIR Standard | ||||
| Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state | ||||
| Organization.contact.purpose | extensible | ContactEntityType http://hl7.org/fhir/ValueSet/contactentity-typefrom the FHIR Standard | 
| Id | Grade | Path(s) | Details | Requirements | 
| organization-meta-profile-version | warning | Organization | Organization: meta.profile with canonical and major.minor. version required. : meta.profile.exists($this.startsWith('http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization|2.1')) | |
| uncontained-requires-lastUpdated | error | Organization | meta.lastUpdated required if not a contained resource : %resource = %rootResource implies meta.lastUpdated.exists() | |
| us-core-18 | error | Organization.identifier:CLIA | CLIA number must be 10 digits with a letter "D" in third position : value.matches('^[0-9]{2}D[0-9]{7}$') | 
This structure is derived from USCoreOrganizationProfile
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints  | 
|---|---|---|---|---|
|   Organization | C | 0..* | USCoreOrganizationProfile(6.1.0) | A grouping of people or organizations with a common purpose This profile also complies with the profile US Core Organization Profile (3.1.1) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management org-1: The organization SHALL at least have a name or an identifier, and possibly more than one 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 | SΣ | 1..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children | 
|     lastUpdated | SΣ | 0..1 | instant | When the resource version last changed ele-1: All FHIR elements must have a @value or children | 
|     profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children | 
|    implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | 
|    modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | 
|    Slices for identifier | SΣC | 0..* | Identifier | Identifies this organization  across multiple systems Slice: Unordered, Open by pattern:$this ele-1: All FHIR elements must have a @value or children | 
|     identifier:NPI | SΣC | 0..* | Identifier | National Provider Identifier (NPI) ele-1: All FHIR elements must have a @value or children us-core-16: NPI must be 10 digits us-core-17: NPI check digit must be valid (Luhn algorithm check) Required Pattern: At least the following | 
|      type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
|       coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
|        system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
|        code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NPI | |
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
|     identifier:CLIA | ΣC | 0..* | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories ele-1: All FHIR elements must have a @value or children us-core-18: CLIA number must be 10 digits with a letter "D" in third position Required Pattern: At least the following | 
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7 | |
|     identifier:NAIC | SΣC | 0..* | Identifier | NAIC Code ele-1: All FHIR elements must have a @value or children us-core-19: NAIC must be 5 digits Required Pattern: At least the following | 
|      type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
|       coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
|        system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType | |
|        code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: naiccode | |
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.300 | |
|     identifier:tax | SΣC | 0..* | Identifier | Tax ID Number ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | 
|      type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
|       coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
|        system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
|        code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: TAX | |
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.4 | |
|     identifier:payerid | SΣC | 0..* | Identifier | Payer ID used in HIPAA covered claims submission transactions ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | 
|      type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
|       coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
|        system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType | |
|        code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: payerid | |
|    active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use ele-1: All FHIR elements must have a @value or children | 
|    name | SΣC | 1..1 | string | Name used for the organization ele-1: All FHIR elements must have a @value or children | 
|    telecom | SC | 0..* | ContactPoint | A contact detail for the organization ele-1: All FHIR elements must have a @value or children org-3: The telecom of an organization can never be of use 'home' | 
|     system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children | 
|     value | SΣ | 0..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children | 
|     use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children | 
|    address | SC | 0..* | Address | An address for the organization ele-1: All FHIR elements must have a @value or children org-2: An address of an organization can never be of use 'home' | 
|     use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home | 
|     line | SΣ | 0..4 | string | Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | 
|     city | SΣ | 0..1 | string | Name of city, town etc. ele-1: All FHIR elements must have a @value or children Example General: Erewhon | 
|     state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. ele-1: All FHIR elements must have a @value or children | 
|     postalCode | SΣ | 0..1 | string | US Zip Codes ele-1: All FHIR elements must have a @value or children Example General: 9132 | 
|     country | SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) ele-1: All FHIR elements must have a @value or children | 
|  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| Organization.telecom.system | required | ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| Organization.telecom.use | required | ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | |
| Organization.address.use | required | AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | |
| Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state | 
| Id | Grade | Path(s) | Details | Requirements | 
| organization-meta-profile-version | warning | Organization | Organization: meta.profile with canonical and major.minor. version required. : meta.profile.exists($this.startsWith('http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization|2.1')) | |
| uncontained-requires-lastUpdated | error | Organization | meta.lastUpdated required if not a contained resource : %resource = %rootResource implies meta.lastUpdated.exists() | |
| us-core-18 | error | Organization.identifier:CLIA | CLIA number must be 10 digits with a letter "D" in third position : value.matches('^[0-9]{2}D[0-9]{7}$') | 
Differential View
This structure is derived from USCoreOrganizationProfile
| Name | Flags | Card. | Type | Description & Constraints  | 
|---|---|---|---|---|
|   Organization | C | 0..* | USCoreOrganizationProfile(6.1.0) | A grouping of people or organizations with a common purpose This profile also complies with the profile US Core Organization Profile (3.1.1) 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 | S | 1..1 | Meta | Metadata about the resource | 
|     lastUpdated | S | 0..1 | instant | When the resource version last changed | 
|     profile | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
|    Slices for identifier | Content/Rules for all slices | |||
|     identifier:NPI | 0..* | Identifier | National Provider Identifier (NPI) Required Pattern: At least the following | |
|      type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
|       coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
|        system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
|        code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NPI | |
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
|     identifier:NAIC | S | 0..* | Identifier | NAIC Code Required Pattern: At least the following | 
|      type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
|       coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
|        system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType | |
|        code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: naiccode | |
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.300 | |
|     identifier:tax | S | 0..* | Identifier | Tax ID Number Required Pattern: At least the following | 
|      type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
|       coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
|        system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
|        code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: TAX | |
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.4 | |
|     identifier:payerid | S | 0..* | Identifier | Payer ID used in HIPAA covered claims submission transactions Required Pattern: At least the following | 
|      type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
|       coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
|        system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType | |
|        code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: payerid | |
|    address | 0..* | Address | An address for the organization | |
|  Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements | 
| organization-meta-profile-version | warning | Organization | Organization: meta.profile with canonical and major.minor. version required. : meta.profile.exists($this.startsWith('http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization|2.1')) | |
| uncontained-requires-lastUpdated | error | Organization | meta.lastUpdated required if not a contained resource : %resource = %rootResource implies meta.lastUpdated.exists() | 
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints  | ||||
|---|---|---|---|---|---|---|---|---|
|   Organization | C | 0..* | USCoreOrganizationProfile(6.1.0) | A grouping of people or organizations with a common purpose This profile also complies with the profile US Core Organization Profile (3.1.1) org-1: The organization SHALL at least have a name or an identifier, and possibly more than one 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. | ||||
|    id | Σ | 0..1 | id | Logical id of this artifact | ||||
|    meta | SΣ | 1..1 | Meta | Metadata about the resource | ||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|     versionId | Σ | 0..1 | id | Version specific identifier | ||||
|     lastUpdated | SΣ | 0..1 | instant | When the resource version last changed | ||||
|     source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
|     profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
|     security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
|     tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
|    implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|    language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
 | |||||
|    text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
|    contained | 0..* | Resource | Contained, inline Resources | |||||
|    extension | 0..* | Extension | Additional content defined by implementations | |||||
|    modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
|    Slices for identifier | SΣC | 0..* | Identifier | Identifies this organization  across multiple systems Slice: Unordered, Open by pattern:$this | ||||
|     identifier:NPI | SΣC | 0..* | Identifier | National Provider Identifier (NPI) us-core-16: NPI must be 10 digits us-core-17: NPI check digit must be valid (Luhn algorithm check) Required Pattern: At least the following | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations | |||||
|      use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
|      type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
|       id | 0..1 | string | Unique id for inter-element referencing | |||||
|       extension | 0..* | Extension | Additional content defined by implementations | |||||
|       coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
|        id | 0..1 | string | Unique id for inter-element referencing | |||||
|        extension | 0..* | Extension | Additional content defined by implementations | |||||
|        system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
|        version | 0..1 | string | Version of the system - if relevant | |||||
|        code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NPI | |||||
|        display | 0..1 | string | Representation defined by the system | |||||
|        userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
|       text | 0..1 | string | Plain text representation of the concept | |||||
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |||||
|      value | 0..1 | string | The value that is unique | |||||
|      period | 0..1 | Period | Time period when id is/was valid for use | |||||
|      assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
|     identifier:CLIA | ΣC | 0..* | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories us-core-18: CLIA number must be 10 digits with a letter "D" in third position Required Pattern: At least the following | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations | |||||
|      use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
|      type | 0..1 | CodeableConcept | Description of identifier | |||||
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7 | |||||
|      value | 0..1 | string | The value that is unique | |||||
|      period | 0..1 | Period | Time period when id is/was valid for use | |||||
|      assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
|     identifier:NAIC | SΣC | 0..* | Identifier | NAIC Code us-core-19: NAIC must be 5 digits Required Pattern: At least the following | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations | |||||
|      use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
|      type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
|       id | 0..1 | string | Unique id for inter-element referencing | |||||
|       extension | 0..* | Extension | Additional content defined by implementations | |||||
|       coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
|        id | 0..1 | string | Unique id for inter-element referencing | |||||
|        extension | 0..* | Extension | Additional content defined by implementations | |||||
|        system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType | |||||
|        version | 0..1 | string | Version of the system - if relevant | |||||
|        code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: naiccode | |||||
|        display | 0..1 | string | Representation defined by the system | |||||
|        userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
|       text | 0..1 | string | Plain text representation of the concept | |||||
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.300 | |||||
|      value | 0..1 | string | The value that is unique | |||||
|      period | 0..1 | Period | Time period when id is/was valid for use | |||||
|      assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
|     identifier:tax | SΣC | 0..* | Identifier | Tax ID Number Required Pattern: At least the following | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations | |||||
|      use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
|      type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
|       id | 0..1 | string | Unique id for inter-element referencing | |||||
|       extension | 0..* | Extension | Additional content defined by implementations | |||||
|       coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
|        id | 0..1 | string | Unique id for inter-element referencing | |||||
|        extension | 0..* | Extension | Additional content defined by implementations | |||||
|        system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
|        version | 0..1 | string | Version of the system - if relevant | |||||
|        code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: TAX | |||||
|        display | 0..1 | string | Representation defined by the system | |||||
|        userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
|       text | 0..1 | string | Plain text representation of the concept | |||||
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.4 | |||||
|      value | 0..1 | string | The value that is unique | |||||
|      period | 0..1 | Period | Time period when id is/was valid for use | |||||
|      assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
|     identifier:payerid | SΣC | 0..* | Identifier | Payer ID used in HIPAA covered claims submission transactions Required Pattern: At least the following | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations | |||||
|      use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
|      type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
|       id | 0..1 | string | Unique id for inter-element referencing | |||||
|       extension | 0..* | Extension | Additional content defined by implementations | |||||
|       coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
|        id | 0..1 | string | Unique id for inter-element referencing | |||||
|        extension | 0..* | Extension | Additional content defined by implementations | |||||
|        system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType | |||||
|        version | 0..1 | string | Version of the system - if relevant | |||||
|        code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: payerid | |||||
|        display | 0..1 | string | Representation defined by the system | |||||
|        userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
|       text | 0..1 | string | Plain text representation of the concept | |||||
|      system | 0..1 | uri | The namespace for the identifier value | |||||
|      value | 0..1 | string | The value that is unique | |||||
|      period | 0..1 | Period | Time period when id is/was valid for use | |||||
|      assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
|    active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use | ||||
|    type | Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example): Used to categorize the organization. | ||||
|    name | SΣC | 1..1 | string | Name used for the organization | ||||
|    alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
|    telecom | SC | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' | ||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|     system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
|     value | SΣ | 0..1 | string | The actual contact point details | ||||
|     use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
|     rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
|     period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
|    address | SC | 0..* | Address | An address for the organization org-2: An address of an organization can never be of use 'home' | ||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|     use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
|     type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
|     text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
|     line | SΣ | 0..4 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
|     city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
|     district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
|     state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. | ||||
|     postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 | ||||
|     country | SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
|     period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
|    partOf | Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part | ||||
|    contact | 0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations | |||||
|     modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
|     purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
|     name | 0..1 | HumanName | A name associated with the contact | |||||
|     telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.)  for a contact | |||||
|     address | 0..1 | Address | Visiting or postal addresses for the contact | |||||
|    endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
|  Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Organization.meta.security | extensible | All Security Labels http://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Organization.meta.tag | example | CommonTags http://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| Organization.language | preferred | CommonLanguages http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard 
 | ||||
| Organization.type | example | OrganizationType http://hl7.org/fhir/ValueSet/organization-typefrom the FHIR Standard | ||||
| Organization.telecom.system | required | ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| Organization.telecom.use | required | ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| Organization.address.use | required | AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | ||||
| Organization.address.type | required | AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1from the FHIR Standard | ||||
| Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state | ||||
| Organization.contact.purpose | extensible | ContactEntityType http://hl7.org/fhir/ValueSet/contactentity-typefrom the FHIR Standard | 
| Id | Grade | Path(s) | Details | Requirements | 
| organization-meta-profile-version | warning | Organization | Organization: meta.profile with canonical and major.minor. version required. : meta.profile.exists($this.startsWith('http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization|2.1')) | |
| uncontained-requires-lastUpdated | error | Organization | meta.lastUpdated required if not a contained resource : %resource = %rootResource implies meta.lastUpdated.exists() | |
| us-core-18 | error | Organization.identifier:CLIA | CLIA number must be 10 digits with a letter "D" in third position : value.matches('^[0-9]{2}D[0-9]{7}$') | 
This structure is derived from USCoreOrganizationProfile
Other representations of profile: CSV, Excel, Schematron