C4DIC Organization - CARIN Digital Insurance Card v1.1.0

Logical id of this artifact

Meta

Metadata about the resource

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

versionId

Σ

0..1

Version specific identifier

lastUpdated

SΣ

1..1

instant

When the resource version last changed

source

Σ

0..1

Identifies where the resource comes from

Slices for profile

Σ

1..*

Profiles this resource claims to conform to
Slice: Unordered, Open by pattern:$this

profile:supportedProfile

Σ

1..1

Profiles this resource claims to conform to

Required Pattern: http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Organization

security

Σ

0..*

Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.

tag

Σ

0..*

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

A set of rules under which this content was created

language

0..1

Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional Bindings

Purpose

AllLanguages

Max Binding

0..1

Narrative

Text summary of the resource, for human interpretation

contained

0..*

Resource

Contained, inline Resources

0..*

Additional content defined by implementations

modifierExtension

?!

0..*

Extensions that cannot be ignored

Slices for identifier

SΣC

0..*

Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this

identifier:NPI

SΣC

0..1

National Provider Identifier (NPI)

Required Pattern: At least the following

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

0..1

usual | official | temp | secondary | old (If known)

0..1

Description of identifier

1..1

The namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi

0..1

The value that is unique

0..1

Time period when id is/was valid for use

0..1

Organization that issued id (may be just text)

identifier:CLIA

SΣC

0..1

Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories

Required Pattern: At least the following

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

0..1

usual | official | temp | secondary | old (If known)

0..1

Description of identifier

1..1

The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7

0..1

The value that is unique

0..1

Time period when id is/was valid for use

0..1

Organization that issued id (may be just text)

identifier:payerid

SΣC

0..*

Payer ID

Required Pattern: At least the following

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

0..1

usual | official | temp | secondary | old (If known)

1..1

Description of identifier
Fixed Value: (complex)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

coding

1..*

Code defined by a terminology system
Fixed Value: (complex)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/insurance-card/CodeSystem/C4DICIdentifierType

version

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: payerid

display

0..1

Representation defined by the system

userSelected

0..1

If this coding was chosen directly by the user

0..1

Plain text representation of the concept

0..1

The namespace for the identifier value

0..1

The value that is unique

0..1

Time period when id is/was valid for use

0..1

Organization that issued id (may be just text)

active

?!SΣ

1..1

Whether the organization's record is still in active use

Σ

0..*

Kind of organization
Binding: OrganizationType (example): Used to categorize the organization.

name

SΣC

1..1

Name used for the organization

alias

0..*

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'

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

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

use

?!Σ

0..1

home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.

Example General: home

Σ

0..1

postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).

Example General: both

Σ

0..1

Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132

line

SΣ

0..4

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

Name of city, town etc.
Example General: Erewhon

district

Σ

0..1

District name (aka county)
Example General: Madison

state

SΣ

0..1

Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

postalCode

SΣ

0..1

US Zip Codes
Example General: 9132

country

SΣ

0..1

Country (e.g. can be ISO 3166 2 or 3 letter code)

Σ

0..1

Time period when address was/is in use
Example General: {"start":"2010-03-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"}

partOf

Σ

0..1

The organization of which this organization forms a part

contact

S

0..*

BackboneElement

Contact for the organization for a certain purpose

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

modifierExtension

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

purpose

0..1

Documentation for this format

The type of contact
Binding: C4DIC Contact Type (extensible)

name

0..1

HumanName

A name associated with the contact

telecom

S

0..*

ContactPoint

Contact details (telephone, email, etc.) for a contact

address

S

0..1

Address

Visiting or postal addresses for the contact

endpoint

0..*

Reference(Endpoint)

Technical endpoints providing access to services operated for the organization

Terminology Bindings

Path Conformance ValueSet URI

Organization.meta.security

extensible

All Security Labels

http://hl7.org/fhir/ValueSet/security-labels

from the FHIR Standard

Organization.meta.tag

example

CommonTags

http://hl7.org/fhir/ValueSet/common-tags

from the FHIR Standard

Organization.language

preferred

CommonLanguages

Additional Bindings

Purpose

AllLanguages

Max Binding

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

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

C4DICContactTypeVS

http://hl7.org/fhir/us/insurance-card/ValueSet/C4DICContactTypeVS

from this IG

This structure is derived from USCoreOrganizationProfile

Summary

Mandatory: 4 elements
Must-Support: 6 elements

Slices

This structure defines the following Slices:

The element 1 is sliced based on the value of Organization.meta.profile

Differential View

This structure is derived from USCoreOrganizationProfile

Name	Flags	Card.	Type	Description & Constraints
Organization			USCoreOrganizationProfile
meta	S	1..1	Meta	Metadata about the resource
lastUpdated	S	1..1	instant	When the resource version last changed
Slices for profile		1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to Slice: Unordered, Open by pattern:$this
profile:supportedProfile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Required Pattern: http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Organization
identifier:payerid	S	0..*	Identifier	Payer ID 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/insurance-card/CodeSystem/C4DICIdentifierType
code		1..1	code	Symbol in syntax defined by the system Fixed Value: payerid
contact	S	0..*	BackboneElement	Contact for the organization for a certain purpose
purpose		0..1	CodeableConcept	The type of contact Binding: C4DIC Contact Type (extensible)
telecom	S	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
address	S	0..1	Address	Visiting or postal addresses for the contact
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Organization.contact.purpose	extensible	C4DICContactTypeVS `http://hl7.org/fhir/us/insurance-card/ValueSet/C4DICContactTypeVS` from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	USCoreOrganizationProfile	A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
meta	SΣ	1..1	Meta	Metadata about the resource
lastUpdated	SΣ	1..1	instant	When the resource version last changed
Slices for profile	Σ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to Slice: Unordered, Open by pattern:$this
profile:supportedProfile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Required Pattern: http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Organization
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
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
system		1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
identifier:CLIA	SΣC	0..1	Identifier	Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories 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:payerid	SΣC	0..*	Identifier	Payer ID 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/insurance-card/CodeSystem/C4DICIdentifierType
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
name	SΣC	1..1	string	Name used for the organization
telecom	SC	0..*	ContactPoint	A contact detail for the organization org-3: The telecom of an organization can never be of use 'home'
address	SC	0..*	Address	An address for the organization 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. 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)
contact	S	0..*	BackboneElement	Contact for the organization for a certain purpose
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
purpose		0..1	CodeableConcept	The type of contact Binding: C4DIC Contact Type (extensible)
telecom	S	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
address	S	0..1	Address	Visiting or postal addresses for the contact
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
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`
Organization.contact.purpose	extensible	C4DICContactTypeVS `http://hl7.org/fhir/us/insurance-card/ValueSet/C4DICContactTypeVS` from this IG

Snapshot View

Description & Constraints

Organization

C

0..*

USCoreOrganizationProfile

A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one

id

Σ

0..1

Logical id of this artifact

Meta

Metadata about the resource

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

versionId

Σ

0..1

Version specific identifier

lastUpdated

SΣ

1..1

instant

When the resource version last changed

source

Σ

0..1

Identifies where the resource comes from

Slices for profile

Σ

1..*

Profiles this resource claims to conform to
Slice: Unordered, Open by pattern:$this

profile:supportedProfile

Σ

1..1

Profiles this resource claims to conform to

Required Pattern: http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Organization

security

Σ

0..*

Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.

tag

Σ

0..*

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

A set of rules under which this content was created

language

0..1

Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional Bindings

Purpose

AllLanguages

Max Binding

0..1

Narrative

Text summary of the resource, for human interpretation

contained

0..*

Resource

Contained, inline Resources

0..*

Additional content defined by implementations

modifierExtension

?!

0..*

Extensions that cannot be ignored

Slices for identifier

SΣC

0..*

Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this

identifier:NPI

SΣC

0..1

National Provider Identifier (NPI)

Required Pattern: At least the following

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

0..1

usual | official | temp | secondary | old (If known)

0..1

Description of identifier

1..1

The namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi

0..1

The value that is unique

0..1

Time period when id is/was valid for use

0..1

Organization that issued id (may be just text)

identifier:CLIA

SΣC

0..1

Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories

Required Pattern: At least the following

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

0..1

usual | official | temp | secondary | old (If known)

0..1

Description of identifier

1..1

The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7

0..1

The value that is unique

0..1

Time period when id is/was valid for use

0..1

Organization that issued id (may be just text)

identifier:payerid

SΣC

0..*

Payer ID

Required Pattern: At least the following

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

0..1

usual | official | temp | secondary | old (If known)

1..1

Description of identifier
Fixed Value: (complex)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

coding

1..*

Code defined by a terminology system
Fixed Value: (complex)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

1..1

Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/insurance-card/CodeSystem/C4DICIdentifierType

version

0..1

Version of the system - if relevant

1..1

Symbol in syntax defined by the system
Fixed Value: payerid

display

0..1

Representation defined by the system

userSelected

0..1

If this coding was chosen directly by the user

0..1

Plain text representation of the concept

0..1

The namespace for the identifier value

0..1

The value that is unique

0..1

Time period when id is/was valid for use

0..1

Organization that issued id (may be just text)

active

?!SΣ

1..1

Whether the organization's record is still in active use

Σ

0..*

Kind of organization
Binding: OrganizationType (example): Used to categorize the organization.

name

SΣC

1..1

Name used for the organization

alias

0..*

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'

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

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

use

?!Σ

0..1

home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.

Example General: home

Σ

0..1

postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).

Example General: both

Σ

0..1

Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132

line

SΣ

0..4

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

Name of city, town etc.
Example General: Erewhon

district

Σ

0..1