1.7.1 - release

SHINNYHRSN - Local Development build (v1.7.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: SHINNY Organization Profile

Official URL: http://test.shinny.org/us/ny/hrsn/StructureDefinition/shin-ny-organization | Version: 1.7.1
Active as of 2025-12-09 | Computable Name: SHINNYOrganizationProfile

- SHINNY HRSN: Needed for Assessments and Referrals. Include in the Assessment and Task bundles.
- Profiled off of the USCore Organization: This profile sets minimum expectations for the Organization resource to searching for and fetching a Organization associated with a patient or provider. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

### Purpose

The SHINNY Organization resource is profiled off of the USCore Organization profile, which sets minimum expectations for the Organization resource for searching and fetching an Organization associated with a patient or a provider. It identifies core elements, extensions, vocabularies and value sets that SHALL be present in the resource when using this profile.

### Usage

The organization profile is required for all screening, assessment and referral bundles.

#### Required Organization Identifier Types

When an organization is provided, one of the following types of identifiers is required: Tax Identifier Number (TIN), Medicaid Management Information System (MMIS), or National Provider Identifier (NPI). More than one of these identifiers is allowed, but only one is required.

In order to ensure one of these codes has been provided, a FHIR rule (invariant) has been created to check the Organization.identifier.type.coding.code. Below are the codes that should be used. A complete list of codes can be found here.

Organization Type | Code
--- | ---
Tax Identifier Number (TIN) | TAX
Medicaid Management Information System (MMIS) Provider Identifier | MA
National Provider Identifier (NPI) | NPI

Usages:

- Examples for this Profile: CBO, Care Ridge SCN and Health System Org

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C | 0..* | USCoreOrganizationProfile | A grouping of people or organizations with a common purpose Constraints: org-1, Organization-ID
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: SHINNYLanguageVS (preferred)
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..1 | Identifier | National Provider Identifier (NPI) 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: 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:CMS | S Σ C | 0..1 | Identifier | Identifies this organization across multiple systems 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: http://www.medicaid.gov/
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:SCN | S Σ C | 0..1 | Identifier | Identifies this organization across multiple systems 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: http://www.scn.ny.gov/
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:CBO | S Σ C | 0..1 | Identifier | Identifies this organization across multiple systems 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: http://www.cbo.ny.gov/
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:OID | S Σ C | 0..1 | Identifier | Identifies this organization across multiple systems 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: http://www.hl7.org/oid/
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..1 | Identifier | Identifies this organization across multiple systems 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: http://www.irs.gov/
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
name | S Σ C | 1..1 | string | Name used for the organization
telecom | S C | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
address | S C | 0..* | Address | An address for the organization Constraints: org-2
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
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
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)
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Organization.language | preferred | SHINNYLanguageVS `http://test.shinny.org/us/ny/hrsn/ValueSet/SHINNYLanguageVS` From this IG
Organization.address.use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.1` From the FHIR Standard
Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes `http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state`

#### Constraints

Id | Grade | Path(s) | Details | Requirements
Organization-ID | error | Organization | Ensure that all Organization resources include a value for one of the following id types: NPI, TAX, or MA. : where(identifier.type.coding.code='NPI').exists() or (identifier.type.coding.code='TAX').exists() or (identifier.type.coding.code='MA').exists() |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Organization | 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 | error | Organization | 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 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 |
org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() |
org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |

This structure is derived from USCoreOrganizationProfile

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C | 0..* | USCoreOrganizationProfile | A grouping of people or organizations with a common purpose Constraints: Organization-ID
language |  | 0..1 | code | Language of the resource content Binding: SHINNYLanguageVS (preferred)
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:CLIA |  | 0..0 |  |
identifier:CMS |  | 0..1 | Identifier | Identifies this organization across multiple systems Required Pattern: At least the following
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://www.medicaid.gov/
identifier:SCN |  | 0..1 | Identifier | Identifies this organization across multiple systems Required Pattern: At least the following
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://www.scn.ny.gov/
identifier:CBO |  | 0..1 | Identifier | Identifies this organization across multiple systems Required Pattern: At least the following
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://www.cbo.ny.gov/
identifier:OID |  | 0..1 | Identifier | Identifies this organization across multiple systems Required Pattern: At least the following
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://www.hl7.org/oid/
identifier:TAX |  | 0..1 | Identifier | Identifies this organization across multiple systems Required Pattern: At least the following
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://www.irs.gov/
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Organization.language | preferred | SHINNYLanguageVS `http://test.shinny.org/us/ny/hrsn/ValueSet/SHINNYLanguageVS` From this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
Organization-ID | error | Organization | Ensure that all Organization resources include a value for one of the following id types: NPI, TAX, or MA. : where(identifier.type.coding.code='NPI').exists() or (identifier.type.coding.code='TAX').exists() or (identifier.type.coding.code='MA').exists() |

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C | 0..* | USCoreOrganizationProfile | A grouping of people or organizations with a common purpose Constraints: org-1, Organization-ID
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: SHINNYLanguageVS (preferred)
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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..1 | Identifier | National Provider Identifier (NPI) 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: 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:CMS | S Σ C | 0..1 | Identifier | Identifies this organization across multiple systems 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: http://www.medicaid.gov/
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:SCN | S Σ C | 0..1 | Identifier | Identifies this organization across multiple systems 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: http://www.scn.ny.gov/
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:CBO | S Σ C | 0..1 | Identifier | Identifies this organization across multiple systems 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: http://www.cbo.ny.gov/
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:OID | S Σ C | 0..1 | Identifier | Identifies this organization across multiple systems 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: http://www.hl7.org/oid/
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..1 | Identifier | Identifies this organization across multiple systems 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: http://www.irs.gov/
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 | S C | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
address | S C | 0..* | Address | An address for the organization Constraints: org-2
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

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Organization.language | preferred | SHINNYLanguageVS `http://test.shinny.org/us/ny/hrsn/ValueSet/SHINNYLanguageVS` From this IG
Organization.type | example | OrganizationType `http://hl7.org/fhir/ValueSet/organization-type` From the FHIR Standard
Organization.address.use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.1` From the FHIR Standard
Organization.address.type | required | AddressType `http://hl7.org/fhir/ValueSet/address-type|4.0.1` From the FHIR Standard
Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes `http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state`
Organization.contact.purpose | extensible | ContactEntityType `http://hl7.org/fhir/ValueSet/contactentity-type` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
Organization-ID | error | Organization | Ensure that all Organization resources include a value for one of the following id types: NPI, TAX, or MA. : where(identifier.type.coding.code='NPI').exists() or (identifier.type.coding.code='TAX').exists() or (identifier.type.coding.code='MA').exists() |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Organization | 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 | error | Organization | 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 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 |
org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() |
org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |

This structure is derived from USCoreOrganizationProfile

Summary

Prohibited: 1 element

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C | 0..* | USCoreOrganizationProfile | A grouping of people or organizations with a common purpose Constraints: org-1, Organization-ID
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: SHINNYLanguageVS (preferred)
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..1 | Identifier | National Provider Identifier (NPI) 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: 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:CMS | S Σ C | 0..1 | Identifier | Identifies this organization across multiple systems 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: http://www.medicaid.gov/
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:SCN | S Σ C | 0..1 | Identifier | Identifies this organization across multiple systems 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: http://www.scn.ny.gov/
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:CBO | S Σ C | 0..1 | Identifier | Identifies this organization across multiple systems 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: http://www.cbo.ny.gov/
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:OID | S Σ C | 0..1 | Identifier | Identifies this organization across multiple systems 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: http://www.hl7.org/oid/
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..1 | Identifier | Identifies this organization across multiple systems 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: http://www.irs.gov/
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
name | S Σ C | 1..1 | string | Name used for the organization
telecom | S C | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
address | S C | 0..* | Address | An address for the organization Constraints: org-2
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
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
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)
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Organization.language | preferred | SHINNYLanguageVS `http://test.shinny.org/us/ny/hrsn/ValueSet/SHINNYLanguageVS` From this IG
Organization.address.use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.1` From the FHIR Standard
Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes `http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state`

#### Constraints

Id | Grade | Path(s) | Details | Requirements
Organization-ID | error | Organization | Ensure that all Organization resources include a value for one of the following id types: NPI, TAX, or MA. : where(identifier.type.coding.code='NPI').exists() or (identifier.type.coding.code='TAX').exists() or (identifier.type.coding.code='MA').exists() |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Organization | 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 | error | Organization | 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 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 |
org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() |
org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |

Differential View

This structure is derived from USCoreOrganizationProfile

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C | 0..* | USCoreOrganizationProfile | A grouping of people or organizations with a common purpose Constraints: Organization-ID
language |  | 0..1 | code | Language of the resource content Binding: SHINNYLanguageVS (preferred)
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:CLIA |  | 0..0 |  |
identifier:CMS |  | 0..1 | Identifier | Identifies this organization across multiple systems Required Pattern: At least the following
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://www.medicaid.gov/
identifier:SCN |  | 0..1 | Identifier | Identifies this organization across multiple systems Required Pattern: At least the following
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://www.scn.ny.gov/
identifier:CBO |  | 0..1 | Identifier | Identifies this organization across multiple systems Required Pattern: At least the following
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://www.cbo.ny.gov/
identifier:OID |  | 0..1 | Identifier | Identifies this organization across multiple systems Required Pattern: At least the following
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://www.hl7.org/oid/
identifier:TAX |  | 0..1 | Identifier | Identifies this organization across multiple systems Required Pattern: At least the following
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://www.irs.gov/
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Organization.language | preferred | SHINNYLanguageVS `http://test.shinny.org/us/ny/hrsn/ValueSet/SHINNYLanguageVS` From this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
Organization-ID | error | Organization | Ensure that all Organization resources include a value for one of the following id types: NPI, TAX, or MA. : where(identifier.type.coding.code='NPI').exists() or (identifier.type.coding.code='TAX').exists() or (identifier.type.coding.code='MA').exists() |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Organization | C | 0..* | USCoreOrganizationProfile | A grouping of people or organizations with a common purpose Constraints: org-1, Organization-ID
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: SHINNYLanguageVS (preferred)
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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..1 | Identifier | National Provider Identifier (NPI) 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: 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:CMS | S Σ C | 0..1 | Identifier | Identifies this organization across multiple systems 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: http://www.medicaid.gov/
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:SCN | S Σ C | 0..1 | Identifier | Identifies this organization across multiple systems 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: http://www.scn.ny.gov/
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:CBO | S Σ C | 0..1 | Identifier | Identifies this organization across multiple systems 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: http://www.cbo.ny.gov/
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:OID | S Σ C | 0..1 | Identifier | Identifies this organization across multiple systems 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: http://www.hl7.org/oid/
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..1 | Identifier | Identifies this organization across multiple systems 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: http://www.irs.gov/
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 | S C | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3
address | S C | 0..* | Address | An address for the organization Constraints: org-2
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

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Organization.language | preferred | SHINNYLanguageVS `http://test.shinny.org/us/ny/hrsn/ValueSet/SHINNYLanguageVS` From this IG
Organization.type | example | OrganizationType `http://hl7.org/fhir/ValueSet/organization-type` From the FHIR Standard
Organization.address.use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.1` From the FHIR Standard
Organization.address.type | required | AddressType `http://hl7.org/fhir/ValueSet/address-type|4.0.1` From the FHIR Standard
Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes `http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state`
Organization.contact.purpose | extensible | ContactEntityType `http://hl7.org/fhir/ValueSet/contactentity-type` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
Organization-ID | error | Organization | Ensure that all Organization resources include a value for one of the following id types: NPI, TAX, or MA. : where(identifier.type.coding.code='NPI').exists() or (identifier.type.coding.code='TAX').exists() or (identifier.type.coding.code='MA').exists() |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Organization | 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 | error | Organization | 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 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 |
org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() |
org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |

This structure is derived from USCoreOrganizationProfile

Summary

Prohibited: 1 element

Other representations of profile: CSV, Excel, Schematron