CARIN Digital Insurance Card
0.1.0 - STU 1 Ballot

This page is part of the CARIN Digital Insurance Card (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: C4DIC Organization

Defining URL:http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Organization
Version:0.1.0
Name:C4DICOrganization
Title:C4DIC Organization
Status:Active as of 12/6/21 10:19 PM
Definition:

This profile builds upon the US Core Organization profile. It is used to convey a payer organization.

Publisher:HL7 Payer/Provider Information Exchange Working Group (PIE WG)
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

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

Formal Views of Profile Content

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

This structure is derived from USCoreOrganizationProfile

Summary

Mandatory: 4 elements
Must-Support: 6 elements

Slices

This structure defines the following Slices:

  • The element Organization.meta.profile is sliced based on the value of pattern:$this

This structure is derived from USCoreOrganizationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*USCoreOrganizationProfileA grouping of people or organizations with a common purpose
... meta S1..1MetaMetadata about the resource
.... lastUpdated S1..1instantWhen 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..1canonical(StructureDefinition)Profiles this resource claims to conform to
Required Pattern: http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Organization
... identifier:payerid S0..*IdentifierPayer ID

Required Pattern: At least the following
.... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/insurance-card/CodeSystem/C4DICIdentifierType
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: payerid
... contact S0..*BackboneElementContact for the organization for a certain purpose
.... purpose 0..1CodeableConceptThe type of contact
Binding: C4DIC Contact Type (extensible)
.... telecom S0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address S0..1AddressVisiting or postal addresses for the contact

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*USCoreOrganizationProfileA grouping of people or organizations with a common purpose
... id Σ0..1stringLogical id of this artifact
... meta SΣ1..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated SΣ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... Slices for profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
Slice: Unordered, Open by pattern:$this
..... profile:supportedProfile Σ1..1canonical(StructureDefinition)Profiles this resource claims to conform to

Required Pattern: http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Organization
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣI0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI SΣI0..1IdentifierNational Provider Identifier (NPI)

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:CLIA ΣI0..1IdentifierClinical Laboratory Improvement Amendments (CLIA) Number for laboratories

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:payerid SΣI0..*IdentifierPayer ID

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/insurance-card/CodeSystem/C4DICIdentifierType
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: payerid
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system0..1uriThe namespace for the identifier value
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
... type Σ0..*CodeableConceptKind of organization
Binding: OrganizationType (example): Used to categorize the organization.


... name SΣI1..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom SI0..*ContactPointA contact detail for the organization
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address SI0..*AddressAn address for the organization
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..4stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
... contact S0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: C4DIC Contact Type (extensible)
.... name 0..1HumanNameA name associated with the contact
.... telecom S0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address S0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*USCoreOrganizationProfileA grouping of people or organizations with a common purpose
... meta Σ1..1MetaMetadata about the resource
.... lastUpdated Σ1..1instantWhen the resource version last changed
... Slices for identifier ΣI0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI ΣI0..1IdentifierNational Provider Identifier (NPI)

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
.... identifier:payerid ΣI0..*IdentifierPayer ID

Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/insurance-card/CodeSystem/C4DICIdentifierType
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: payerid
... active ?!Σ1..1booleanWhether the organization's record is still in active use
... telecom I0..*ContactPointA contact detail for the organization
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ0..1stringThe actual contact point details
... address I0..*AddressAn address for the organization
.... line Σ0..4stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
.... city Σ0..1stringName of city, town etc.
.... state Σ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode Σ0..1stringUS Zip Codes
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact

doco Documentation for this format

This structure is derived from USCoreOrganizationProfile

Summary

Mandatory: 4 elements
Must-Support: 6 elements

Slices

This structure defines the following Slices:

  • The element Organization.meta.profile is sliced based on the value of pattern:$this

Differential View

This structure is derived from USCoreOrganizationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*USCoreOrganizationProfileA grouping of people or organizations with a common purpose
... meta S1..1MetaMetadata about the resource
.... lastUpdated S1..1instantWhen 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..1canonical(StructureDefinition)Profiles this resource claims to conform to
Required Pattern: http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Organization
... identifier:payerid S0..*IdentifierPayer ID

Required Pattern: At least the following
.... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/insurance-card/CodeSystem/C4DICIdentifierType
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: payerid
... contact S0..*BackboneElementContact for the organization for a certain purpose
.... purpose 0..1CodeableConceptThe type of contact
Binding: C4DIC Contact Type (extensible)
.... telecom S0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address S0..1AddressVisiting or postal addresses for the contact

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*USCoreOrganizationProfileA grouping of people or organizations with a common purpose
... id Σ0..1stringLogical id of this artifact
... meta SΣ1..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated SΣ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... Slices for profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
Slice: Unordered, Open by pattern:$this
..... profile:supportedProfile Σ1..1canonical(StructureDefinition)Profiles this resource claims to conform to

Required Pattern: http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Organization
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣI0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI SΣI0..1IdentifierNational Provider Identifier (NPI)

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:CLIA ΣI0..1IdentifierClinical Laboratory Improvement Amendments (CLIA) Number for laboratories

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:payerid SΣI0..*IdentifierPayer ID

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/insurance-card/CodeSystem/C4DICIdentifierType
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: payerid
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system0..1uriThe namespace for the identifier value
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
... type Σ0..*CodeableConceptKind of organization
Binding: OrganizationType (example): Used to categorize the organization.


... name SΣI1..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom SI0..*ContactPointA contact detail for the organization
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address SI0..*AddressAn address for the organization
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..4stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
... contact S0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: C4DIC Contact Type (extensible)
.... name 0..1HumanNameA name associated with the contact
.... telecom S0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address S0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Organization.meta.securityextensibleAll Security Labels
Organization.meta.tagexampleCommonTags
Organization.languagepreferredCommonLanguages
Max Binding: AllLanguages
Organization.typeexampleOrganizationType
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.address.typerequiredAddressType
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes
Organization.contact.purposeextensibleC4DICContactTypeVS